@ncksnydr/config-js 0.2.0

package/README.md

@@ -0,0 +1,116 @@
+# @ncksnydr/config-js
+
+Shared configuration for TypeScript, ESLint, Prettier and Vitest. Each configuration is a separate entry point, so a Consumer uses only the parts it needs.
+
+## Install
+
+```sh
+pnpm add --save-dev @ncksnydr/config-js typescript eslint prettier vitest
+```
+
+## TypeScript
+
+Extend the base in your `tsconfig.json`:
+
+```json
+{
+  "extends": "@ncksnydr/config-js/tsconfig"
+}
+```
+
+The base is strict, uses Node's own import rules (`nodenext`), and targets ES2024.
+
+The base loads no global types. TypeScript 6 loads none by default, and a browser app must not see Node's types. If your code runs in Node, install `@types/node` and add the Node types yourself:
+
+```json
+{
+  "extends": "@ncksnydr/config-js/tsconfig",
+  "compilerOptions": {
+    "types": ["node"]
+  }
+}
+```
+
+## ESLint
+
+Use the configuration as your `eslint.config.js`:
+
+```js
+export { default } from "@ncksnydr/config-js/eslint";
+```
+
+The configuration turns on ESLint's recommended rules and the `strictTypeChecked` rules of typescript-eslint. The typescript-eslint rules read your types, so every TypeScript file must be in a `tsconfig.json`. JavaScript files get no type-aware rules.
+
+### Import boundaries
+
+An import boundary stops one part of your code from importing another part. Declare your boundaries with `boundaries()`:
+
+```js
+import config, { boundaries } from "@ncksnydr/config-js/eslint";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig(
+  config,
+  boundaries(import.meta.dirname, [
+    {
+      because: "A shared package cannot depend on an app.",
+      cannotImport: ["apps/*/**"],
+      files: "packages/*/**",
+    },
+  ]),
+);
+```
+
+The first argument is the folder that the paths start from. Pass `import.meta.dirname`, so the paths start at the folder of your `eslint.config.js`. Each boundary has three parts:
+
+- `because` is the reason. ESLint prints it in the error.
+- `cannotImport` lists globs of the files that the covered files cannot import.
+- `files` is a glob of the files that the boundary covers.
+
+An import across a boundary fails lint:
+
+```text
+packages/shared/heading.ts
+  1:23  error  Unexpected path "../../apps/blog/post.js" imported in restricted zone. A shared package cannot depend on an app  import-x/no-restricted-paths
+```
+
+A boundary goes one way. In the example, an app can still import a shared package.
+
+## Prettier
+
+Use the configuration as your `prettier.config.js`:
+
+```js
+export { default } from "@ncksnydr/config-js/prettier";
+```
+
+The configuration needs Prettier 3.5 or later. It sets every Prettier layout option, so a new Prettier default cannot change your layout. Lines wrap at 120 characters. Strings use double quotes, statements end with a semicolon, and a list gets a comma after its last item. Markdown lines stay as you wrote them.
+
+The configuration also sorts imports in three groups: Node's built-in modules, then packages, then relative files. An import in the wrong order fails the check:
+
+```text
+Checking formatting...
+[warn] index.ts
+[warn] Code style issues found in the above file. Run Prettier with --write to fix.
+```
+
+To fix the layout, run `prettier --write .`.
+
+## Vitest
+
+Use the preset as your `vitest.config.ts`:
+
+```ts
+export { default } from "@ncksnydr/config-js/vitest";
+```
+
+To change a setting, merge the preset with your own configuration:
+
+```ts
+import preset from "@ncksnydr/config-js/vitest";
+import { defineConfig, mergeConfig } from "vitest/config";
+
+export default mergeConfig(preset, defineConfig({ test: { include: ["tests/**/*.test.ts"] } }));
+```
+
+The preset runs tests in Node and finds `*.test.ts` files next to the code. It restores mocks between tests. If it finds no tests, the run fails.

package/dist/eslint.d.ts

@@ -0,0 +1,9 @@
+import type { Linter } from "eslint";
+export interface Boundary {
+    because: string;
+    cannotImport: string[];
+    files: string;
+}
+export declare function boundaries(root: string, importBoundaries: Boundary[]): Linter.Config;
+declare const _default: import("eslint/config").ConfigObject[];
+export default _default;

package/dist/eslint.js

@@ -0,0 +1,40 @@
+import js from "@eslint/js";
+import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
+import { importX } from "eslint-plugin-import-x";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+export function boundaries(root, importBoundaries) {
+    return {
+        name: "@ncksnydr/config-js/boundaries",
+        plugins: {
+            "import-x": importX,
+        },
+        rules: {
+            "import-x/no-restricted-paths": [
+                "error",
+                {
+                    basePath: root,
+                    zones: importBoundaries.map(({ because, cannotImport, files }) => ({
+                        from: cannotImport,
+                        message: because,
+                        target: files,
+                    })),
+                },
+            ],
+        },
+        settings: {
+            "import-x/resolver-next": [createTypeScriptImportResolver()],
+        },
+    };
+}
+export default defineConfig(js.configs.recommended, tseslint.configs.strictTypeChecked, {
+    languageOptions: {
+        parserOptions: {
+            projectService: true,
+        },
+    },
+}, {
+    extends: [tseslint.configs.disableTypeChecked],
+    files: ["**/*.{js,mjs,cjs}"],
+});
+//# sourceMappingURL=eslint.js.map

package/dist/eslint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint.js","sourceRoot":"","sources":["../src/eslint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,EAAE,8BAA8B,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAQzC,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,gBAA4B;IACnE,OAAO;QACL,IAAI,EAAE,gCAAgC;QACtC,OAAO,EAAE;YACP,UAAU,EAAE,OAAO;SACpB;QACD,KAAK,EAAE;YACL,8BAA8B,EAAE;gBAC9B,OAAO;gBACP;oBACE,QAAQ,EAAE,IAAI;oBACd,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;wBACjE,IAAI,EAAE,YAAY;wBAClB,OAAO,EAAE,OAAO;wBAChB,MAAM,EAAE,KAAK;qBACd,CAAC,CAAC;iBACJ;aACF;SACF;QACD,QAAQ,EAAE;YACR,wBAAwB,EAAE,CAAC,8BAA8B,EAAE,CAAC;SAC7D;KACF,CAAC;AACJ,CAAC;AAED,eAAe,YAAY,CACzB,EAAE,CAAC,OAAO,CAAC,WAAW,EACtB,QAAQ,CAAC,OAAO,CAAC,iBAAiB,EAClC;IACE,eAAe,EAAE;QACf,aAAa,EAAE;YACb,cAAc,EAAE,IAAI;SACrB;KACF;CACF,EACD;IACE,OAAO,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC;IAC9C,KAAK,EAAE,CAAC,mBAAmB,CAAC;CAC7B,CACF,CAAC"}

package/dist/prettier.d.ts

@@ -0,0 +1,3 @@
+import type { PrettierConfig } from "@ianvs/prettier-plugin-sort-imports";
+declare const config: PrettierConfig;
+export default config;

package/dist/prettier.js

@@ -0,0 +1,28 @@
+import { fileURLToPath } from "node:url";
+const sortImportsPlugin = fileURLToPath(import.meta.resolve("@ianvs/prettier-plugin-sort-imports"));
+const config = {
+    arrowParens: "always",
+    bracketSameLine: false,
+    bracketSpacing: true,
+    embeddedLanguageFormatting: "auto",
+    endOfLine: "lf",
+    experimentalOperatorPosition: "end",
+    experimentalTernaries: false,
+    htmlWhitespaceSensitivity: "css",
+    importOrder: ["<BUILTIN_MODULES>", "<THIRD_PARTY_MODULES>", "^[.]"],
+    jsxSingleQuote: false,
+    objectWrap: "preserve",
+    plugins: [sortImportsPlugin],
+    printWidth: 120,
+    proseWrap: "preserve",
+    quoteProps: "as-needed",
+    semi: true,
+    singleAttributePerLine: false,
+    singleQuote: false,
+    tabWidth: 2,
+    trailingComma: "all",
+    useTabs: false,
+    vueIndentScriptAndStyle: false,
+};
+export default config;
+//# sourceMappingURL=prettier.js.map

package/dist/prettier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prettier.js","sourceRoot":"","sources":["../src/prettier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,MAAM,iBAAiB,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC,CAAC;AAEpG,MAAM,MAAM,GAAmB;IAC7B,WAAW,EAAE,QAAQ;IACrB,eAAe,EAAE,KAAK;IACtB,cAAc,EAAE,IAAI;IACpB,0BAA0B,EAAE,MAAM;IAClC,SAAS,EAAE,IAAI;IACf,4BAA4B,EAAE,KAAK;IACnC,qBAAqB,EAAE,KAAK;IAC5B,yBAAyB,EAAE,KAAK;IAChC,WAAW,EAAE,CAAC,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,CAAC;IACnE,cAAc,EAAE,KAAK;IACrB,UAAU,EAAE,UAAU;IACtB,OAAO,EAAE,CAAC,iBAAiB,CAAC;IAC5B,UAAU,EAAE,GAAG;IACf,SAAS,EAAE,UAAU;IACrB,UAAU,EAAE,WAAW;IACvB,IAAI,EAAE,IAAI;IACV,sBAAsB,EAAE,KAAK;IAC7B,WAAW,EAAE,KAAK;IAClB,QAAQ,EAAE,CAAC;IACX,aAAa,EAAE,KAAK;IACpB,OAAO,EAAE,KAAK;IACd,uBAAuB,EAAE,KAAK;CAC/B,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/vitest.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/dist/vitest.js

@@ -0,0 +1,10 @@
+import { defineConfig } from "vitest/config";
+export default defineConfig({
+    test: {
+        environment: "node",
+        include: ["**/*.test.ts"],
+        restoreMocks: true,
+        passWithNoTests: false,
+    },
+});
+//# sourceMappingURL=vitest.js.map

package/dist/vitest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.js","sourceRoot":"","sources":["../src/vitest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE;QACJ,WAAW,EAAE,MAAM;QACnB,OAAO,EAAE,CAAC,cAAc,CAAC;QACzB,YAAY,EAAE,IAAI;QAClB,eAAe,EAAE,KAAK;KACvB;CACF,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@ncksnydr/config-js",
+  "version": "0.2.0",
+  "description": "Shared TypeScript, ESLint, Prettier and Vitest configuration for Nick Snyder's codebases",
+  "repository": {
+    "directory": "packages/config-js",
+    "type": "git",
+    "url": "git+https://github.com/ncksnydr/e2.git"
+  },
+  "type": "module",
+  "exports": {
+    "./eslint": {
+      "types": "./dist/eslint.d.ts",
+      "default": "./dist/eslint.js"
+    },
+    "./prettier": {
+      "types": "./dist/prettier.d.ts",
+      "default": "./dist/prettier.js"
+    },
+    "./tsconfig": "./tsconfig/base.json",
+    "./vitest": {
+      "types": "./dist/vitest.d.ts",
+      "default": "./dist/vitest.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/fixtures",
+    "!src/testing",
+    "tsconfig"
+  ],
+  "peerDependencies": {
+    "eslint": "^10.0.0",
+    "prettier": "^3.5.0",
+    "typescript": "^6.0.0",
+    "vitest": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
+    "prettier": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    },
+    "vitest": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@eslint/js": "^10.0.1",
+    "@ianvs/prettier-plugin-sort-imports": "^4.7.1",
+    "eslint-import-resolver-typescript": "^4.4.5",
+    "eslint-plugin-import-x": "^4.18.1",
+    "typescript-eslint": "^8.72.2"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.6",
+    "eslint": "^10.14.0",
+    "prettier": "^3.10.0",
+    "typescript": "~6.0.3",
+    "vitest": "^5.1.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/src/eslint.ts

@@ -0,0 +1,53 @@
+import js from "@eslint/js";
+import type { Linter } from "eslint";
+import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";
+import { importX } from "eslint-plugin-import-x";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+
+export interface Boundary {
+  because: string;
+  cannotImport: string[];
+  files: string;
+}
+
+export function boundaries(root: string, importBoundaries: Boundary[]): Linter.Config {
+  return {
+    name: "@ncksnydr/config-js/boundaries",
+    plugins: {
+      "import-x": importX,
+    },
+    rules: {
+      "import-x/no-restricted-paths": [
+        "error",
+        {
+          basePath: root,
+          zones: importBoundaries.map(({ because, cannotImport, files }) => ({
+            from: cannotImport,
+            message: because,
+            target: files,
+          })),
+        },
+      ],
+    },
+    settings: {
+      "import-x/resolver-next": [createTypeScriptImportResolver()],
+    },
+  };
+}
+
+export default defineConfig(
+  js.configs.recommended,
+  tseslint.configs.strictTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+    },
+  },
+  {
+    extends: [tseslint.configs.disableTypeChecked],
+    files: ["**/*.{js,mjs,cjs}"],
+  },
+);

package/src/prettier.ts

@@ -0,0 +1,31 @@
+import { fileURLToPath } from "node:url";
+import type { PrettierConfig } from "@ianvs/prettier-plugin-sort-imports";
+
+const sortImportsPlugin = fileURLToPath(import.meta.resolve("@ianvs/prettier-plugin-sort-imports"));
+
+const config: PrettierConfig = {
+  arrowParens: "always",
+  bracketSameLine: false,
+  bracketSpacing: true,
+  embeddedLanguageFormatting: "auto",
+  endOfLine: "lf",
+  experimentalOperatorPosition: "end",
+  experimentalTernaries: false,
+  htmlWhitespaceSensitivity: "css",
+  importOrder: ["<BUILTIN_MODULES>", "<THIRD_PARTY_MODULES>", "^[.]"],
+  jsxSingleQuote: false,
+  objectWrap: "preserve",
+  plugins: [sortImportsPlugin],
+  printWidth: 120,
+  proseWrap: "preserve",
+  quoteProps: "as-needed",
+  semi: true,
+  singleAttributePerLine: false,
+  singleQuote: false,
+  tabWidth: 2,
+  trailingComma: "all",
+  useTabs: false,
+  vueIndentScriptAndStyle: false,
+};
+
+export default config;

package/src/vitest.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    environment: "node",
+    include: ["**/*.test.ts"],
+    restoreMocks: true,
+    passWithNoTests: false,
+  },
+});

package/tsconfig/base.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "noImplicitOverride": true,
+    "noFallthroughCasesInSwitch": true,
+    "verbatimModuleSyntax": true,
+    "erasableSyntaxOnly": true,
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "target": "es2024",
+    "skipLibCheck": true,
+    "declaration": true,
+    "sourceMap": true
+  }
+}