@michaelhelvey/vite-config 1.0.0 → 1.0.2

package/README.md

@@ -1,8 +1,6 @@
 # @michaelhelvey/vite-config
 
-Opinionated, shareable [vite-plus](https://github.com/nicolo-ribaudo/vite-plus) defaults for
-TypeScript projects. One import gives you sane formatting, linting, testing, and pre-commit hook
-configuration — no per-project bikeshedding required.
+Opinionated defaults for [Vite+](https://viteplus.dev/).
 
 ## Install
 
@@ -24,51 +22,6 @@ export default defineConfig({
 });
 ```
 
-That's it. You now have working `vp fmt`, `vp check`, and `vp test` commands with the defaults
-below, plus a pre-commit hook that runs `vp check --fix` on staged files.
-
-## What's included
-
-### Formatting (`fmt`)
-
-Powered by [oxfmt](https://github.com/nicolo-ribaudo/oxfmt) via vite-plus:
-
-- 100 character print width
-- Semicolons, double quotes, trailing commas
-- 2-space indentation, no tabs
-- Prose wrapping enabled
-- Import sorting (builtin → third-party → everything else)
-
-### Linting (`lint`)
-
-Powered by [oxlint](https://oxc.rs) via vite-plus, with type-aware checking enabled. Rules are
-selected by filtering the full oxlint rule set against a curated combination of plugins and
-categories:
-
-| Preset             | Plugins                                                       | Categories                    |
-| ------------------ | ------------------------------------------------------------- | ----------------------------- |
-| `production_node`  | eslint, oxc, typescript, promise                              | correctness, perf, suspicious |
-| `production_react` | eslint, oxc, typescript, promise, react, react-perf, jsx-a11y | correctness, perf, suspicious |
-| `test`             | eslint, oxc, promise, vitest                                  | correctness                   |
-
-File-level overrides apply automatically:
-
-- `**/*.tsx` files use the `production_react` preset
-- `*/*.test.*` files use the `test` preset
-- Everything else uses `production_node`
-
-Ignore patterns are read from your repository's `.gitignore` at config load time.
-
-### Testing (`test`)
-
-- Pass with no test files
-- Unstub globals and env vars between tests
-- Reset mocks between tests
-
-### Pre-commit (`staged`)
-
-All staged files are run through `vp check --fix` before each commit.
-
 ## Customization
 
 ### Extending the default config

package/dist/index.d.mts

@@ -0,0 +1,32 @@
+import { t as RULES } from "./rules-DdF6uL2A.mjs";
+import { UserConfig } from "vite-plus";
+
+//#region src/index.d.ts
+type OxlintPluginType = (typeof RULES)[number]["scope"];
+type OxlintCategoryType = (typeof RULES)[number]["category"];
+interface CustomDefaultsEntry {
+  categories: OxlintCategoryType[];
+  plugins: OxlintPluginType[];
+}
+interface CustomDefaults {
+  production_node: CustomDefaultsEntry;
+  production_react: CustomDefaultsEntry;
+  test: CustomDefaultsEntry;
+}
+/**
+ * Mapping from a broad category of code "e.g. nodejs production code" to a list of categories and
+ * oxlint plugins to enable.
+ */
+declare const customOxlintDefaults: CustomDefaults;
+type CustomOxlintCategory = keyof typeof customOxlintDefaults;
+/**
+ * Finds the root of the git repository, then loads any .gitignore files there, then returns a list
+ * of glob patterns from it. Doesn't handle GIT_DIR or worktrees or any weird shit.
+ */
+declare const ignoresFromGitIgnore: () => Promise<string[]>;
+declare const pluginsForCategory: (category: CustomOxlintCategory) => ("eslint" | "import" | "jest" | "jsdoc" | "jsx-a11y" | "nextjs" | "node" | "oxc" | "promise" | "react" | "react-perf" | "typescript" | "unicorn" | "vitest" | "vue")[];
+declare const rulesForCategory: (category: CustomOxlintCategory) => Record<string, "error">;
+declare const DEFAULT_USER_CONFIG: UserConfig;
+//#endregion
+export { customOxlintDefaults, DEFAULT_USER_CONFIG as default, ignoresFromGitIgnore, pluginsForCategory, rulesForCategory };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,144 @@
+import { t as RULES } from "./rules-CnWlgdks.mjs";
+import { spawn } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+//#region src/index.ts
+/**
+* Mapping from a broad category of code "e.g. nodejs production code" to a list of categories and
+* oxlint plugins to enable.
+*/
+const customOxlintDefaults = {
+	production_node: {
+		categories: [
+			"correctness",
+			"perf",
+			"suspicious"
+		],
+		plugins: [
+			"eslint",
+			"oxc",
+			"typescript",
+			"promise"
+		]
+	},
+	production_react: {
+		categories: [
+			"correctness",
+			"perf",
+			"suspicious"
+		],
+		plugins: [
+			"eslint",
+			"oxc",
+			"typescript",
+			"promise",
+			"react",
+			"react-perf",
+			"jsx-a11y"
+		]
+	},
+	test: {
+		categories: ["correctness"],
+		plugins: [
+			"eslint",
+			"oxc",
+			"promise",
+			"vitest"
+		]
+	}
+};
+/**
+* Finds the root of the git repository, then loads any .gitignore files there, then returns a list
+* of glob patterns from it. Doesn't handle GIT_DIR or worktrees or any weird shit.
+*/
+const ignoresFromGitIgnore = async () => {
+	const gitRoot = await new Promise((resolve, reject) => {
+		const cp = spawn("git", ["rev-parse", "--show-toplevel"], { stdio: "pipe" });
+		cp.on("error", reject);
+		cp.stdout?.on("data", (pathBuf) => {
+			resolve(pathBuf.toString("utf-8").trim());
+		});
+	});
+	const gitIgnorePath = path.join(gitRoot, ".gitignore");
+	if (await fs.promises.access(gitIgnorePath, fs.constants.R_OK).then(() => true).catch(() => false)) return (await fs.promises.readFile(gitIgnorePath, "utf-8")).split(/\s/);
+	return [];
+};
+const pluginsForCategory = (category) => customOxlintDefaults[category].plugins;
+const rulesForCategory = (category) => {
+	const rules = {};
+	const config = customOxlintDefaults[category];
+	for (const rule of RULES) if (config.plugins.includes(rule.scope) && config.categories.includes(rule.category)) rules[`${rule.scope}/${rule.value}`] = "error";
+	return rules;
+};
+const DEFAULT_USER_CONFIG = {
+	staged: { "*": "vp check --fix" },
+	fmt: {
+		sortImports: {
+			customGroups: [
+				{
+					groupName: "builtin",
+					selector: "builtin"
+				},
+				{
+					groupName: "thirdparty",
+					selector: "external"
+				},
+				{
+					groupName: "everything-else",
+					elementNamePattern: ["*"]
+				}
+			],
+			newlinesBetween: false,
+			sortPackageJson: true
+		},
+		printWidth: 100,
+		proseWrap: "always",
+		semi: true,
+		singleQuote: false,
+		tabWidth: 2,
+		trailingComma: "all",
+		useTabs: false
+	},
+	lint: {
+		env: {
+			browser: true,
+			builtin: true,
+			es2024: true,
+			node: true
+		},
+		ignorePatterns: await ignoresFromGitIgnore(),
+		plugins: pluginsForCategory("production_node"),
+		rules: {
+			...rulesForCategory("production_node"),
+			"typescript/consistent-type-imports": ["error", {
+				fixStyle: "separate-type-imports",
+				prefer: "type-imports"
+			}],
+			"eslint/no-shadow": "off",
+			"typescript/no-unsafe-type-assertion": "off"
+		},
+		overrides: [{
+			files: ["**/*.tsx"],
+			plugins: pluginsForCategory("production_react"),
+			rules: rulesForCategory("production_react")
+		}, {
+			files: ["*/*.test.*"],
+			plugins: pluginsForCategory("test"),
+			rules: rulesForCategory("test")
+		}],
+		options: {
+			typeAware: true,
+			typeCheck: true
+		}
+	},
+	test: {
+		passWithNoTests: true,
+		unstubGlobals: true,
+		unstubEnvs: true,
+		mockReset: true
+	}
+};
+//#endregion
+export { customOxlintDefaults, DEFAULT_USER_CONFIG as default, ignoresFromGitIgnore, pluginsForCategory, rulesForCategory };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { spawn } from \"node:child_process\";\nimport fs from \"node:fs\";\nimport path from \"node:path\";\nimport type { UserConfig } from \"vite-plus\";\nimport { RULES } from \"./rules.ts\";\n\ntype OxlintPluginType = (typeof RULES)[number][\"scope\"];\ntype OxlintCategoryType = (typeof RULES)[number][\"category\"];\n\ninterface CustomDefaultsEntry {\n  categories: OxlintCategoryType[];\n  plugins: OxlintPluginType[];\n}\n\ninterface CustomDefaults {\n  production_node: CustomDefaultsEntry;\n  production_react: CustomDefaultsEntry;\n  test: CustomDefaultsEntry;\n}\n\n/**\n * Mapping from a broad category of code \"e.g. nodejs production code\" to a list of categories and\n * oxlint plugins to enable.\n */\nexport const customOxlintDefaults: CustomDefaults = {\n  production_node: {\n    categories: [\"correctness\", \"perf\", \"suspicious\"],\n    plugins: [\"eslint\", \"oxc\", \"typescript\", \"promise\"],\n  },\n  production_react: {\n    categories: [\"correctness\", \"perf\", \"suspicious\"],\n    plugins: [\"eslint\", \"oxc\", \"typescript\", \"promise\", \"react\", \"react-perf\", \"jsx-a11y\"],\n  },\n  test: {\n    categories: [\"correctness\"],\n    plugins: [\"eslint\", \"oxc\", \"promise\", \"vitest\"],\n  },\n};\n\ntype CustomOxlintCategory = keyof typeof customOxlintDefaults;\n\n/**\n * Finds the root of the git repository, then loads any .gitignore files there, then returns a list\n * of glob patterns from it. Doesn't handle GIT_DIR or worktrees or any weird shit.\n */\nexport const ignoresFromGitIgnore = async (): Promise<string[]> => {\n  const gitRoot = await new Promise<string>((resolve, reject) => {\n    const cp = spawn(\"git\", [\"rev-parse\", \"--show-toplevel\"], { stdio: \"pipe\" });\n    cp.on(\"error\", reject);\n\n    cp.stdout?.on(\"data\", (pathBuf: Buffer) => {\n      resolve(pathBuf.toString(\"utf-8\").trim());\n    });\n  });\n\n  const gitIgnorePath = path.join(gitRoot, \".gitignore\");\n  const gitIgnoreExists = await fs.promises\n    .access(gitIgnorePath, fs.constants.R_OK)\n    .then(() => true)\n    .catch(() => false);\n\n  if (gitIgnoreExists) {\n    const gitIgnoreContents = await fs.promises.readFile(gitIgnorePath, \"utf-8\");\n    return gitIgnoreContents.split(/\\s/);\n  }\n\n  return [];\n};\n\nexport const pluginsForCategory = (category: CustomOxlintCategory) =>\n  customOxlintDefaults[category].plugins;\nexport const rulesForCategory = (category: CustomOxlintCategory) => {\n  const rules: Record<string, \"error\"> = {};\n  const config = customOxlintDefaults[category];\n\n  for (const rule of RULES) {\n    if (config.plugins.includes(rule.scope) && config.categories.includes(rule.category)) {\n      rules[`${rule.scope}/${rule.value}`] = \"error\";\n    }\n  }\n\n  return rules;\n};\n\nconst DEFAULT_STAGED: UserConfig[\"staged\"] = {\n  \"*\": \"vp check --fix\",\n};\n\nconst DEFAULT_FMT: UserConfig[\"fmt\"] = {\n  sortImports: {\n    customGroups: [\n      { groupName: \"builtin\", selector: \"builtin\" },\n      { groupName: \"thirdparty\", selector: \"external\" },\n      { groupName: \"everything-else\", elementNamePattern: [\"*\"] },\n    ],\n    newlinesBetween: false,\n    sortPackageJson: true,\n  },\n  printWidth: 100,\n  proseWrap: \"always\",\n  semi: true,\n  singleQuote: false,\n  tabWidth: 2,\n  trailingComma: \"all\",\n  useTabs: false,\n};\n\nconst DEFAULT_LINT: UserConfig[\"lint\"] = {\n  env: {\n    browser: true,\n    builtin: true,\n    es2024: true,\n    node: true,\n  },\n  ignorePatterns: await ignoresFromGitIgnore(),\n  plugins: pluginsForCategory(\"production_node\"),\n  rules: {\n    ...rulesForCategory(\"production_node\"),\n    \"typescript/consistent-type-imports\": [\n      \"error\",\n      { fixStyle: \"separate-type-imports\", prefer: \"type-imports\" },\n    ],\n    \"eslint/no-shadow\": \"off\",\n    \"typescript/no-unsafe-type-assertion\": \"off\",\n  },\n  overrides: [\n    {\n      files: [\"**/*.tsx\"],\n      plugins: pluginsForCategory(\"production_react\"),\n      rules: rulesForCategory(\"production_react\"),\n    },\n    {\n      files: [\"*/*.test.*\"],\n      plugins: pluginsForCategory(\"test\"),\n      rules: rulesForCategory(\"test\"),\n    },\n  ],\n  options: {\n    typeAware: true,\n    typeCheck: true,\n  },\n};\n\nconst DEFAULT_TEST: UserConfig[\"test\"] = {\n  passWithNoTests: true,\n  unstubGlobals: true,\n  unstubEnvs: true,\n  mockReset: true,\n};\n\nconst DEFAULT_USER_CONFIG: UserConfig = {\n  staged: DEFAULT_STAGED,\n  fmt: DEFAULT_FMT,\n  lint: DEFAULT_LINT,\n  test: DEFAULT_TEST,\n};\n\nexport default DEFAULT_USER_CONFIG;\n"],"mappings":";;;;;;;;;AAwBA,MAAa,uBAAuC;CAClD,iBAAiB;EACf,YAAY;GAAC;GAAe;GAAQ;GAAa;EACjD,SAAS;GAAC;GAAU;GAAO;GAAc;GAAU;EACpD;CACD,kBAAkB;EAChB,YAAY;GAAC;GAAe;GAAQ;GAAa;EACjD,SAAS;GAAC;GAAU;GAAO;GAAc;GAAW;GAAS;GAAc;GAAW;EACvF;CACD,MAAM;EACJ,YAAY,CAAC,cAAc;EAC3B,SAAS;GAAC;GAAU;GAAO;GAAW;GAAS;EAChD;CACF;;;;;AAQD,MAAa,uBAAuB,YAA+B;CACjE,MAAM,UAAU,MAAM,IAAI,SAAiB,SAAS,WAAW;EAC7D,MAAM,KAAK,MAAM,OAAO,CAAC,aAAa,kBAAkB,EAAE,EAAE,OAAO,QAAQ,CAAC;AAC5E,KAAG,GAAG,SAAS,OAAO;AAEtB,KAAG,QAAQ,GAAG,SAAS,YAAoB;AACzC,WAAQ,QAAQ,SAAS,QAAQ,CAAC,MAAM,CAAC;IACzC;GACF;CAEF,MAAM,gBAAgB,KAAK,KAAK,SAAS,aAAa;AAMtD,KALwB,MAAM,GAAG,SAC9B,OAAO,eAAe,GAAG,UAAU,KAAK,CACxC,WAAW,KAAK,CAChB,YAAY,MAAM,CAInB,SAD0B,MAAM,GAAG,SAAS,SAAS,eAAe,QAAQ,EACnD,MAAM,KAAK;AAGtC,QAAO,EAAE;;AAGX,MAAa,sBAAsB,aACjC,qBAAqB,UAAU;AACjC,MAAa,oBAAoB,aAAmC;CAClE,MAAM,QAAiC,EAAE;CACzC,MAAM,SAAS,qBAAqB;AAEpC,MAAK,MAAM,QAAQ,MACjB,KAAI,OAAO,QAAQ,SAAS,KAAK,MAAM,IAAI,OAAO,WAAW,SAAS,KAAK,SAAS,CAClF,OAAM,GAAG,KAAK,MAAM,GAAG,KAAK,WAAW;AAI3C,QAAO;;AAqET,MAAM,sBAAkC;CACtC,QAnE2C,EAC3C,KAAK,kBACN;CAkEC,KAhEqC;EACrC,aAAa;GACX,cAAc;IACZ;KAAE,WAAW;KAAW,UAAU;KAAW;IAC7C;KAAE,WAAW;KAAc,UAAU;KAAY;IACjD;KAAE,WAAW;KAAmB,oBAAoB,CAAC,IAAI;KAAE;IAC5D;GACD,iBAAiB;GACjB,iBAAiB;GAClB;EACD,YAAY;EACZ,WAAW;EACX,MAAM;EACN,aAAa;EACb,UAAU;EACV,eAAe;EACf,SAAS;EACV;CAgDC,MA9CuC;EACvC,KAAK;GACH,SAAS;GACT,SAAS;GACT,QAAQ;GACR,MAAM;GACP;EACD,gBAAgB,MAAM,sBAAsB;EAC5C,SAAS,mBAAmB,kBAAkB;EAC9C,OAAO;GACL,GAAG,iBAAiB,kBAAkB;GACtC,sCAAsC,CACpC,SACA;IAAE,UAAU;IAAyB,QAAQ;IAAgB,CAC9D;GACD,oBAAoB;GACpB,uCAAuC;GACxC;EACD,WAAW,CACT;GACE,OAAO,CAAC,WAAW;GACnB,SAAS,mBAAmB,mBAAmB;GAC/C,OAAO,iBAAiB,mBAAmB;GAC5C,EACD;GACE,OAAO,CAAC,aAAa;GACrB,SAAS,mBAAmB,OAAO;GACnC,OAAO,iBAAiB,OAAO;GAChC,CACF;EACD,SAAS;GACP,WAAW;GACX,WAAW;GACZ;EACF;CAaC,MAXuC;EACvC,iBAAiB;EACjB,eAAe;EACf,YAAY;EACZ,WAAW;EACZ;CAOA"}