Use Rollup to build the configuration files 🛼 (#23)

* Use rollup to copy files to lib folder 🛼

* Use rollup to build Stylelint config 🎊

* Use rollup to build ESLint config 🪩

* Finalise config build process 🍾

* Clean up files after updated build process 🫧

* Test both flat and legacy ESLint options in GitHub action 🧪

.eslintrc

@@ -6,11 +6,7 @@
     // "semi": [1, "always"]
   },
   "parserOptions": {
-    "ecmaFeatures": {
-      "modules": true
-    },
     "ecmaVersion": 2018,
-    "requireConfigFile": false,
     "sourceType": "module"
   }
 }

.github/workflows/test.yml

@@ -27,14 +27,16 @@ jobs:
     - name: Install Dependencies
       run: yarn install --immutable
 
-    - name: Lint
-      run: yarn lint --ignore-patterns '**/*.ts'
-
     - name: Run Tests
       run: yarn test --coverage
 
     - name: Run Build
       run: yarn build
 
+    - name: Lint
+      run: |
+        yarn lint --ignore-patterns '**/*.ts'
+        yarn lint --eslint-use-legacy-config --ignore-patterns '**/*.ts'
+
     - name: Depcheck
       run: npx depcheck

.markdownlint.json

@@ -1,3 +1,3 @@
 {
-  "extends": "./config/markdownlint.json"
+  "extends": "./lib/markdownlint.json"
 }

config/all-legacy.ts

@@ -1,3 +1,41 @@
-import buildLegacyConfig from './eslint/build-legacy-config'
+import { FILE_PATHS } from './eslint/constants'
+import Rules from './eslint/rules'
 
-export default buildLegacyConfig()
+export default {
+  env: {
+    'jest/globals': true,
+  },
+  plugins: [
+    'eslint-comments',
+    'inclusive-language',
+    'n',
+    'promise',
+    'sort-destructure-keys',
+    'sort-exports',
+  ],
+  rules: {
+    ...Rules.ESLintComments,
+    ...Rules.InclusiveLanguage,
+    ...Rules.N,
+    ...Rules.Promise,
+    ...Rules.SortDestructureKeys,
+    ...Rules.SortExports,
+  },
+  overrides: [{
+    files: FILE_PATHS.TESTS,
+    plugins: [
+      'jest',
+    ],
+    rules: {
+      ...Rules.Jest,
+    },
+  }, {
+    files: FILE_PATHS.TESTS_TYPESCRIPT,
+    plugins: [
+      'jest',
+    ],
+    rules: {
+      ...Rules.JestTypescript,
+    },
+  }],
+}

config/all.ts

@@ -1,3 +1,48 @@
-import buildFlatConfig from './eslint/build-flat-config'
+import { FILE_PATHS } from './eslint/constants'
+import Plugins from './eslint/plugins'
+import Rules from './eslint/rules'
 
-export default buildFlatConfig()
+export default [{
+  plugins: {
+    'eslint-comments': Plugins.EslintComments,
+    'inclusive-language': Plugins.InclusiveLanguage,
+    'n': Plugins.N,
+    'promise': Plugins.Promise,
+    'sort-destructure-keys': Plugins.SortDestructureKeys,
+    'sort-exports': Plugins.SortExports,
+  },
+  rules: {
+    ...Rules.ESLintComments,
+    ...Rules.InclusiveLanguage,
+    ...Rules.N,
+    ...Rules.Promise,
+    ...Rules.SortDestructureKeys,
+    ...Rules.SortExports,
+  },
+}, {
+  files: FILE_PATHS.TESTS,
+  languageOptions: {
+    globals: {
+      'jest/globals': true,
+    },
+  },
+  plugins: {
+    'jest': Plugins.Jest,
+  },
+  rules: {
+    ...Rules.Jest,
+  },
+}, {
+  files: FILE_PATHS.TESTS_TYPESCRIPT,
+  languageOptions: {
+    globals: {
+      'jest/globals': true,
+    },
+  },
+  plugins: {
+    'jest': Plugins.Jest,
+  },
+  rules: {
+    ...Rules.JestTypescript,
+  },
+}]

config/stylelint.config.js

@@ -3,7 +3,7 @@ import postcssScss from 'postcss-scss'
 
 import Rules from './stylelint/rules'
 
-export default () => ({
+export default {
   extends: [
     'stylelint-config-property-sort-order-smacss',
   ],
@@ -49,4 +49,4 @@ export default () => ({
     ...Rules.Stylelint,
     ...Rules.Stylistic,
   },
-})
+}

eslint.config.js

@@ -1,10 +1,10 @@
-import config from './config/all.ts'
+import config from './lib/all'
 
 export default [
   ...config,
   {
     rules: {
-      // semi: [2, 'always'],
+      // semi: [1, 'always'],
     }
   }
 ]

jest-config/testData.ts

@@ -1,16 +1,12 @@
-import { type LintError } from 'markdownlint'
+import type { LintError } from 'markdownlint'
 
-export const expectedResultThemes = {
+const expectedResultThemes = {
   messageTheme: expect.any(Function),
   positionTheme: expect.any(Function),
   ruleTheme: expect.any(Function),
 }
 
-/*
- * MARKDOWNLINT
- */
-
-export const markdownlintError: LintError = {
+const markdownlintError: LintError = {
   errorContext: 'test-error-context',
   errorDetail: 'test-error-detail',
   errorRange: [1, 2],
@@ -23,3 +19,8 @@ export const markdownlintError: LintError = {
   ruleInformation: 'test-rule-information',
   ruleNames: ['MD000', 'test-rule-name'],
 }
+
+export {
+  expectedResultThemes,
+  markdownlintError,
+}

package.json

@@ -14,9 +14,8 @@
     "lint-pilot": "index.min.js"
   },
   "scripts": {
-    "build": "rimraf lib && mkdir lib && rollup -c && yarn buildConfig",
-    "buildConfig": "tsx ./scripts/build-config.ts",
-    "lint": "NODE_ENV=development tsx src/index.js --ignore-dirs lib",
+    "build": "rimraf lib && mkdir lib && rollup -c",
+    "lint": "tsx src/index.js --ignore-dirs lib",
     "publishLib": "yarn test --coverage && yarn build && cd lib && npm publish",
     "test": "jest"
   },
@@ -52,7 +51,6 @@
     "@babel/preset-env": "7.25.4",
     "@babel/preset-typescript": "7.24.7",
     "@rollup/plugin-node-resolve": "15.2.3",
-    "@rollup/plugin-replace": "5.0.7",
     "@rollup/plugin-typescript": "11.1.6",
     "@types/eslint": "9.6.1",
     "@types/jest": "29.5.12",
@@ -62,6 +60,7 @@
     "jest": "29.7.0",
     "rimraf": "5.0.10",
     "rollup": "4.21.2",
+    "rollup-plugin-copy": "3.5.0",
     "rollup-plugin-terser": "7.0.2",
     "ts-jest": "29.2.5",
     "ts-node": "10.9.2",

rollup.config.js

@@ -2,28 +2,52 @@ import { readFileSync } from 'node:fs'
 import { resolve } from 'node:path'
 
 import { nodeResolve } from '@rollup/plugin-node-resolve'
-import replace from '@rollup/plugin-replace'
 import typescript from '@rollup/plugin-typescript'
+import copy from 'rollup-plugin-copy'
 import { terser } from 'rollup-plugin-terser'
 
 const packageJSON = JSON.parse(readFileSync(resolve('./package.json'), 'utf-8'))
 
-export default {
+const OUTPUT_DIR = 'lib'
+
+const COPY_FILES = [
+  'config/markdownlint.json',
+  'package.json',
+  'README.md',
+]
+
+const createConfig = (configFile, format) => ({
+  external: Object.keys(packageJSON.dependencies),
+  input: configFile,
+  output: {
+    dir: OUTPUT_DIR,
+    format,
+  },
+  plugins: [
+    nodeResolve(),
+    typescript(),
+  ],
+})
+
+export default [{
   external: Object.keys(packageJSON.dependencies),
   input: 'src/index.ts',
   output: {
-    file: 'lib/index.min.js',
+    file: `${OUTPUT_DIR}/index.min.js`,
     format: 'es',
   },
   plugins: [
     nodeResolve({
       preferBuiltins: true,
     }),
-    replace({
-      'process.env.NODE_ENV': JSON.stringify('production'),
-      preventAssignment: true,
-    }),
-    terser(),
     typescript(),
+    terser(),
+    copy({
+      targets: COPY_FILES.map(file => ({ src: file, dest: OUTPUT_DIR })),
+    }),
   ],
-}
+},
+  createConfig('config/all-legacy.ts', 'cjs'),
+  createConfig('config/all.ts', 'es'),
+  createConfig('config/stylelint.config.js', 'cjs'),
+]