Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@upfluence/w-conf

This package provides shared configuration for web projects at Upfluence.

Installation

pnpm add -D @upfluence/w-conf

Usage

You can extend your project's configuration files with the shared configurations provided by @upfluence/w-conf.

Prettier

The base Prettier configuration includes sensible defaults for code formatting that align with Upfluence's coding standards, including settings for Handlebars files and import sorting.

The Prettier configuration exports a buildConfiguration function that you can use to create your own Prettier configuration. It takes the following options:

interface PrettierConfigurationOptions {
  sortImport?: {
    enabled?: boolean; // default: true
    globPatterns?: string[]; // default: ['**/*.(js|ts)']
    packages?: string[]; // default: []
  };
}

To use, create a prettier.config.mjs file in the root of your project with the following content:

import { buildConfiguration } from '@upfluence/w-conf/prettier';

export default buildConfiguration();

Prettier — Incremental adoption of import sorting

import { buildConfiguration } from '@upfluence/w-conf/prettier';

export default buildConfiguration({
  sortImport: {
    globPatterns: ['packages/(settings-web|affiliates-web)/**/*.(ts)'],
    packages: ['@upfluence/settings-web', '@upfluence/affiliates-web']
  }
});

Prettier — Ensure local package grouping

import { buildConfiguration } from '@upfluence/w-conf/prettier';

export default buildConfiguration({
  sortImport: {
    packages: ['@upfluence/my-local-package']
  }
});

This configuration will ensure that imports from @upfluence/my-local-package are grouped together in your import statements, separately from other external packages.

Prettier — Extending the configuration

If for some reason, you need to extend the base Prettier configuration to either add or override specific settings, you can do so by importing the base configuration and modifying it as needed:

import { buildConfiguration } from '@upfluence/w-conf/prettier';

export default {
  ...buildConfiguration(),
  printWidth: 80 // Override the print width setting
};

ESLint

A shared flat ESLint config (ESLint ≥ 10) for Upfluence Ember apps/addons. It includes:

  • eslint:recommended
  • eslint-plugin-ember (+ emberCompatibilityDisables)
  • typescript-eslint (recommended, untyped)
  • eslint-plugin-qunit for tests
  • eslint-plugin-n for node/config files
  • eslint-config-prettier

References:

Requirements

The ESLint export bundles its plugins and presets as package dependencies. In consumer repositories, the minimal install is:

pnpm add -D @upfluence/w-conf eslint

Legacy Package Removal

When migrating from legacy .eslintrc, you can remove:

pnpm remove @typescript-eslint/parser @typescript-eslint/eslint-plugin

Usage

Create an eslint.config.mjs at the root of your project.

By default, the package exports a standard, zero-config resolved array:

// @ts-check
import { defineConfig } from 'eslint/config';
import upfluence from '@upfluence/w-conf/eslint';

export default defineConfig(...upfluence);

To customize globs/ignores, use buildConfiguration:

import { defineConfig } from 'eslint/config';
import { buildConfiguration } from '@upfluence/w-conf/eslint';

export default defineConfig(
  ...buildConfiguration({
    ignores: ['dist/', 'vendor/', 'declarations/', 'coverage/', 'my-custom-unlinted-folder/'],
    testFiles: ['packages/*/tests/**/*-test.{js,ts}'],
    nodeFiles: ['eslint.config.mjs', 'ember-cli-build.js', 'config/**/*.js', 'scripts/**/*.mjs']
  })
);

Unlike the legacy .eslintrc.js setup, flat config lints .ts files by default — no --ext flag needed.

Note: .ts files are linted via typescript-eslint with its recommended (untyped) preset. Type-aware linting (recommendedTypeChecked) is intentionally deferred.

For advanced composition (monorepos, custom blocks), use named exports and keep eslintConfigPrettierPlaceLast last:

import { defineConfig } from 'eslint/config';
import {
  core,
  emberConfig,
  javascript,
  typescript,
  qunitTests,
  nodeFiles,
  DEFAULT_IGNORES,
  eslintConfigPrettierPlaceLast
} from '@upfluence/w-conf/eslint';

export default defineConfig(
  ...DEFAULT_IGNORES,
  ...core,
  ...emberConfig,
  ...javascript,
  ...typescript,
  ...qunitTests(['packages/*/tests/**/*-test.{js,ts}']),
  ...nodeFiles(),
  eslintConfigPrettierPlaceLast
);

About

Shared configuration for web projects

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages