update dotfiles, configs, scripts, etc

Author: zachbryant

.eslintrc.js

@@ -1,5 +1,4 @@
 module.exports = {
-  root: true,
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint', 'eslint-plugin', 'import', 'jest', 'prettier'],
   env: {
@@ -8,13 +7,12 @@ module.exports = {
   },
   extends: [
     'eslint:recommended',
-    'plugin:import/errors',
-    'plugin:import/warnings',
+    'plugin:import/recommended',
     'plugin:eslint-plugin/all',
     'plugin:prettier/recommended',
   ],
   parserOptions: {
-    ecmaVersion: 10,
+    ecmaVersion: '2024',
     sourceType: 'module',
   },
   rules: {
@@ -28,7 +26,7 @@ module.exports = {
       rules: {
         '@typescript-eslint/explicit-function-return-type': 'off',
         '@typescript-eslint/explicit-module-boundary-types': 'off',
-        '@typescript-eslint/ban-ts-ignore': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
         '@typescript-eslint/no-explicit-any': 'off',
       },
 
@@ -52,17 +50,16 @@ module.exports = {
             'jest/prefer-to-have-length': 'warn',
             'jest/prefer-spy-on': 'error',
             'jest/valid-expect': 'error',
-            'jest/no-test-callback': 'off',
+            'jest/no-done-callback': 'off',
           },
         },
       ],
     },
   ],
   settings: {
     'import/resolver': {
-      node: {
-        moduleDirectory: ['node_modules', 'src'],
-      },
+      node: true,
+      typescript: true,
     },
   },
 }

.github/workflows/publish.yml

@@ -14,9 +14,11 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 18
+          node-version: 20
       - run: yarn
       - run: yarn verify
+        env:
+          MINIFY: true
 
   publish-npm:
     needs: build
@@ -25,9 +27,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 18
+          node-version: 20
           registry-url: https://registry.npmjs.org/
       - run: yarn
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+          MINIFY: true

.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
 
     steps:
       - uses: actions/checkout@v2

.prettierrc.js

@@ -3,4 +3,5 @@ module.exports = {
   trailingComma: 'all',
   arrowParens: 'avoid',
   semi: false,
+  singleQuote: true,
 }

README.md

@@ -2,12 +2,14 @@
 
 # eslint-plugin-typescript-sort-keys
 
-Sort interface and string enum keys
+Sort interface and enum keys
 
 Inspired by and sourced from [eslint/sort-keys]([https://github.com/eslint/eslint/blob/master/docs/rules/sort-keys.md](https://github.com/eslint/eslint/blob/main/docs/src/rules/sort-keys.md))
 
 ## Installation
 
+Supported on Node 18+
+
 You'll first need to install
 
 - [eslint](http://eslint.org)
@@ -50,7 +52,7 @@ Then configure the rules you want to use under the rules section.
 {
   "rules": {
     "typescript-sort-keys/interface": "error",
-    "typescript-sort-keys/string-enum": "error"
+    "typescript-sort-keys/enum": "error"
   }
 }
 ```
@@ -67,12 +69,13 @@ Or enable all rules with defaults
 
 <!-- begin rule list -->
 
-**Key**: :heavy_check_mark: = recommended, :wrench: = fixable
+**Key**: :heavy_check_mark: = recommended, :wrench: = fixable, :warning: = deprecated
 
 <!-- prettier-ignore -->
-| Name | Description | :heavy_check_mark: | :wrench: |
+| Name | Description |  |  |
 | ---- | ----------- | ------------------ | -------- |
 | [`typescript-sort-keys/interface`](./docs/rules/interface.md) | require interface keys to be sorted | :heavy_check_mark: | :wrench: |
-| [`typescript-sort-keys/string-enum`](./docs/rules/string-enum.md) | require string enum members to be sorted | :heavy_check_mark: | :wrench: |
+| [`typescript-sort-keys/enum`](./docs/rules/enum.md) | require enum members to be sorted | :heavy_check_mark: | :wrench: |
+| [`typescript-sort-keys/string-enum`](./docs/rules/string-enum.md) | (**DEPRECATED**) require string enum members to be sorted | :warning: | :wrench: |
 
 <!-- end rule list -->

jest.config.js

@@ -1,4 +1,16 @@
 module.exports = {
-  testRegex: 'tests/.*\\.spec\\.(js|ts)$',
+  coverageDirectory: 'coverage',
+  collectCoverageFrom: ['src/**/*'],
+  coverageReporters: [['text', { skipFull: false, skipEmpty: true }], 'lcov'],
+  coverageThreshold: {
+    global: {
+      branches: 94,
+      functions: 100,
+      lines: 100,
+      statements: 98,
+    },
+  },
   moduleDirectories: ['node_modules', 'src'],
+  randomize: true, // Just to be sure memoization isn't broken
+  testRegex: 'tests/.*\\.spec\\.(js|ts)$',
 }

package.json

@@ -15,7 +15,6 @@
   "files": [
     "/lib",
     "package.json",
-    "CHANGELOG.md",
     "LICENSE.md",
     "README.md"
   ],
@@ -28,69 +27,87 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "prepublishOnly": "yarn compile",
     "build": "yarn rimraf lib && yarn compile",
     "compile": "yarn rollup -c",
-    "docs": "eslint-docs",
+    "coverage-preview": "http-server -o -p 5000 coverage/lcov-report",
+    "deduplicate": "yarn-deduplicate --strategy fewer",
     "docs:check": "eslint-docs check",
-    "lint": "eslint --ext .js,.ts src/ tests/",
+    "docs": "eslint-docs",
     "format": "prettier --write src/**/*.{js,ts} tests/**/*.{js,ts}",
-    "test": "yarn jest --watch",
-    "coverage": "yarn test --coverage --watchAll=false",
-    "coverage-preview": "http-server -o -p 5000 coverage/lcov-report",
+    "lint": "eslint --ext .js,.ts src/ tests/",
+    "prepublishOnly": "MINIFY=1 yarn build",
+    "purge": "yarn -s rimraf node_modules lib",
+    "test:autofix": "yarn -s jest ./tests/autofix.spec.ts",
+    "test:config": "yarn -s jest ./tests/config.spec.ts",
+    "test:interface": "yarn -s jest ./tests/rules/interface/*.spec.ts",
+    "test:rules": "yarn -s jest ./tests/rules/*/*.spec.ts --collectCoverage=true",
+    "test:enum": "yarn -s jest ./tests/rules/enum/*.spec.ts",
+    "test:watch:autofix": "yarn jest --watch ./tests/autofix.spec.ts",
+    "test:watch:config": "yarn jest --watch ./tests/config.spec.ts",
+    "test:watch:interface": "yarn jest --watch ./tests/rules/interface/*.spec.ts",
+    "test:watch:rules": "yarn jest --watch ./tests/rules/*/*.spec.ts",
+    "test:watch:enum": "yarn jest --watch ./tests/rules/enum/*.spec.ts",
+    "test:watch": "yarn -s jest --watch .*.spec.ts",
+    "test": "yarn -s jest .*.spec.ts --collectCoverage=true",
     "typecheck": "tsc --noEmit --skipLibCheck",
-    "verify": "yarn typecheck && yarn lint && yarn build && yarn coverage"
+    "verify": "yarn typecheck && yarn lint && yarn build && yarn test"
   },
   "dependencies": {
-    "@typescript-eslint/experimental-utils": "^5.0.0",
+    "@typescript-eslint/utils": "^6.7.4",
     "json-schema": "^0.4.0",
     "natural-compare-lite": "^1.4.0"
   },
   "devDependencies": {
-    "@babel/cli": "~7.14.8",
-    "@babel/core": "~7.15.0",
-    "@babel/preset-env": "~7.15.0",
-    "@babel/preset-typescript": "~7.15.0",
+    "@babel/cli": "~7.23.0",
+    "@babel/core": "~7.23.0",
+    "@babel/preset-env": "~7.23.0",
+    "@babel/preset-typescript": "~7.23.0",
     "@infctr/eslint-docs": "~0.4.0",
-    "@rollup/plugin-commonjs": "~12.0.0",
-    "@rollup/plugin-json": "~4.0.3",
-    "@rollup/plugin-node-resolve": "~8.0.0",
-    "@rollup/plugin-typescript": "~11.1.2",
-    "@types/babel__core": "~7.1.7",
-    "@types/babel__preset-env": "~7.9.0",
-    "@types/eslint": "~7.28.1",
-    "@types/jest": "~27.0.2",
+    "@rollup/plugin-commonjs": "~25.0.5",
+    "@rollup/plugin-json": "~6.0.1",
+    "@rollup/plugin-node-resolve": "~15.2.2",
+    "@rollup/plugin-terser": "~0.4.4",
+    "@rollup/plugin-typescript": "~11.1.4",
+    "@types/eslint": "~8.44.3",
+    "@types/jest": "~29.5.5",
     "@types/natural-compare-lite": "~1.4.0",
-    "@types/rimraf": "~3.0.1",
-    "@types/tmp": "~0.2.1",
-    "@typescript-eslint/eslint-plugin": "~6.4.0",
-    "@typescript-eslint/parser": "~6.4.0",
-    "babel-jest": "~26.6.3",
-    "babel-plugin-module-resolver": "~4.1.0",
-    "eslint": "~8.0.1",
+    "@types/node": "^18.0.0",
+    "@types/tmp": "~0.2.4",
+    "@typescript-eslint/eslint-plugin": "^6.7.4",
+    "@typescript-eslint/parser": "^6.7.4",
+    "babel-jest": "~29.7.0",
+    "babel-plugin-module-resolver": "~5.0.0",
+    "chalk": "~5.3.0",
+    "eslint": "~8.50.0",
     "eslint-config-prettier": "~9.0.0",
+    "eslint-import-resolver-typescript": "~3.6.1",
     "eslint-plugin-eslint-plugin": "~5.1.1",
-    "eslint-plugin-import": "~2.28.0",
-    "eslint-plugin-jest": "~27.2.3",
+    "eslint-plugin-import": "~2.28.1",
+    "eslint-plugin-jest": "~27.4.2",
     "eslint-plugin-prettier": "~5.0.0",
-    "http-server": "~13.0.0",
+    "http-server": "^14.0.0",
     "husky": "~4.2.5",
-    "jest": "~29.6.2",
-    "lint-staged": "~10.5.4",
-    "prettier": "3.0.1",
-    "rimraf": "~3.0.2",
-    "rollup": "~2.10.5",
+    "jest": "~29.7.0",
+    "lint-staged": "^14.0.1",
+    "lorem-ipsum": "~2.0.8",
+    "prettier": "^3.1.0",
+    "rimraf": "^5.0.5",
+    "rollup": "~4.7.0",
     "tmp": "~0.2.1",
-    "tsconfig": "~7.0.0",
-    "typescript": "5.1.6"
+    "typescript": "~5.2.2",
+    "yarn-deduplicate": "^6.0.2"
   },
   "peerDependencies": {
     "@typescript-eslint/parser": "^6",
     "eslint": "^7 || ^8",
     "typescript": "^3 || ^4 || ^5"
   },
   "engines": {
-    "node": ">= 16"
+    "node": ">=18"
+  },
+  "volta": {
+    "node": "18.19.0",
+    "yarn": "1.22.19"
   },
   "license": "ISC"
 }

rollup.config.js

@@ -0,0 +1,45 @@
+import commonjs from '@rollup/plugin-commonjs'
+import json from '@rollup/plugin-json'
+import resolve from '@rollup/plugin-node-resolve'
+import terser from '@rollup/plugin-terser'
+import typescript from '@rollup/plugin-typescript'
+import assert from 'assert'
+import fs from 'fs'
+import path from 'path'
+
+const minify = !!process.env.MINIFY
+
+const config = JSON.parse(fs.readFileSync('./tsconfig.json', 'utf-8'))
+assert(config)
+const baseUrl = config.compilerOptions.baseUrl
+
+const internalFolders = fs
+  .readdirSync(baseUrl, { withFileTypes: true })
+  .filter(dir => dir.isDirectory())
+  .map(dir => path.resolve(process.cwd(), baseUrl, dir.name))
+
+const isExternal = id =>
+  !id.startsWith('.') &&
+  !id.startsWith('/') &&
+  !id.startsWith('\0') &&
+  !internalFolders.some(mapping => id.startsWith(mapping))
+
+export default [
+  {
+    input: './src/index.ts',
+    external: isExternal,
+    output: [
+      {
+        dir: 'lib',
+        entryFileNames: '[name].cjs.js',
+        format: 'cjs',
+      },
+      {
+        dir: 'lib',
+        entryFileNames: '[name].mjs',
+        format: 'es',
+      },
+    ],
+    plugins: [commonjs(), resolve(), typescript(), json(), minify && terser()],
+  },
+]