@adbayb/stack 2.40.0 → 3.0.0-next-3def11e

package/README.md

@@ -13,7 +13,7 @@
 - Support for several application templates (for now, only a default template is available, but others can be added later)
 - Standardized file structure including optional folder creation such as `examples`, `packages`, ...
 - Enable all project lifecycle steps with commands from the setup, check, fix, build, and test to the versioning and release
-- Built-in configuration preset setup (including Node/NPM runtime, Git ignore/hooks, [TypeScript](https://github.com/adbayb/stack/blob/main/stack/configs/typescript/), [ESLint](https://github.com/adbayb/stack/blob/main/stack/configs/eslint/), [Prettier](https://github.com/adbayb/stack/blob/main/stack/configs/prettier/), EditorConfig, Renovate, Changesets, and VSCode)
+- Built-in configuration preset setup (including Node/NPM runtime, Git ignore/hooks, [TypeScript](https://github.com/adbayb/stack/blob/main/stack/configs/typescript/), [Oxlint](https://github.com/adbayb/stack/blob/main/stack/configs/oxlint/), [Oxfmt](https://github.com/adbayb/stack/blob/main/stack/configs/oxfmt/), EditorConfig, Renovate, Changesets, and VSCode)
 - A welcoming environment for users and contributors with the continuous integration setup, and the creation of `README.md`, `CONTRIBUTING.md`, and GitHub template files (including issue and pull request ones), ...
 - An optimized development environment with command caching (no build needed if nothing changes)
 
@@ -63,13 +63,13 @@ stack release
 
 ### Available configurations
 
-- [@adbayb/stack/eslint](https://github.com/adbayb/stack/blob/main/stack/configs/eslint/) to align logical and stylistic rules across projects.
-- [@adbayb/stack/prettier](https://github.com/adbayb/stack/blob/main/stack/configs/prettier/) to align code formatting conventions across projects.
+- [@adbayb/stack/oxlint](https://github.com/adbayb/stack/blob/main/stack/configs/oxlint/) to align logical and stylistic rules across projects.
+- [@adbayb/stack/oxfmt](https://github.com/adbayb/stack/blob/main/stack/configs/oxfmt/) to align code formatting conventions across projects.
 - [@adbayb/stack/typescript](https://github.com/adbayb/stack/blob/main/stack/configs/typescript/) to align type checking and processing across projects.
 
 ### Used technologies
 
-- **Static code analysis**: ESLint, Prettier
+- **Static code analysis**: Oxlint, Oxfmt
 - **Node package manager**: PNPM
 - **Task orchestration**: Turborepo
 - **Release**: Changesets

package/bin/index.js

@@ -1,7 +1,5 @@
 #!/usr/bin/env node
 
-import { createRequire } from "node:module";
+import pkg from "../package.json" with { type: "json" };
 
-const package_ = createRequire(import.meta.url)("../package.json");
-
-import(new URL(`../${package_.exports["."].default}`, import.meta.url));
+void import(new URL(`../${pkg.exports["."].default}`, import.meta.url));

package/configs/{prettier → oxfmt}/README.md

@@ -1,6 +1,6 @@
 <br>
 <div align="center">
-    <h1>@adbayb/stack/prettier</h1>
+    <h1>@adbayb/stack/oxfmt</h1>
     <strong>My opinionated formatting standards</strong>
 </div>
 <br>
@@ -8,7 +8,7 @@
 
 ## ✨ Features
 
-This package offers opinionated but extensible **[Prettier](https://prettier.io/)** configurations to align code formatting conventions across projects.
+This package offers opinionated but extensible **[Oxfmt](https://oxc.rs/docs/guide/usage/formatter.html)** configurations to align code formatting conventions across projects.
 
 It allows to:
 
@@ -30,18 +30,10 @@ pnpm add @adbayb/stack --save-dev --workspace-root
 
 ### 2️⃣ Usage
 
-Edit the root `package.json` file to include the following:
-
-```jsonc
-{
-	"scripts": {
-		"check:format": "prettier \"**/!(pnpm-lock.yaml)\" --check --ignore-unknown --ignore-path .gitignore --log-level warn",
-		"fix:format": "pnpm check:format --write",
-		// ...
-	},
-	"prettier": "@adbayb/stack/prettier",
-	// ...
-}
+Create a `oxfmt.config.ts` file and include the following:
+
+```ts
+export { default } from "@adbayb/stack/oxfmt";
 ```
 
 <br />

package/configs/oxfmt/index.ts

@@ -0,0 +1,41 @@
+import type { OxfmtConfig } from "oxfmt";
+import { defineConfig } from "oxfmt";
+
+const config = defineConfig({
+	arrowParens: "always",
+	bracketSameLine: false,
+	bracketSpacing: true,
+	embeddedLanguageFormatting: "auto",
+	endOfLine: "lf",
+	htmlWhitespaceSensitivity: "css",
+	ignorePatterns: [],
+	insertFinalNewline: true,
+	jsdoc: true,
+	jsxSingleQuote: false,
+	objectWrap: "preserve",
+	printWidth: 100,
+	proseWrap: "preserve",
+	quoteProps: "consistent",
+	semi: true,
+	singleAttributePerLine: true,
+	singleQuote: false,
+	sortImports: {
+		newlinesBetween: false,
+	},
+	sortPackageJson: true,
+	tabWidth: 4,
+	trailingComma: "all",
+	useTabs: true,
+	vueIndentScriptAndStyle: false,
+});
+
+export const createConfig = ({
+	overrides,
+}: Required<Pick<OxfmtConfig, "overrides">>): OxfmtConfig => {
+	return {
+		...config,
+		overrides,
+	};
+};
+
+export default config;

package/configs/{eslint → oxlint}/README.md

@@ -1,6 +1,6 @@
 <br>
 <div align="center">
-    <h1>@adbayb/stack/eslint</h1>
+    <h1>@adbayb/stack/oxlint</h1>
     <strong>My opinionated linter standards</strong>
 </div>
 <br>
@@ -8,7 +8,7 @@
 
 ## ✨ Features
 
-This package offers opinionated but extensible **[ESLint](https://eslint.org/)** configurations to align logical and stylistic rules across projects.
+This package offers opinionated but extensible **[Oxlint](https://oxc.rs/docs/guide/usage/linter.html)** configurations to align logical and stylistic rules across projects.
 
 It allows to:
 
@@ -30,10 +30,10 @@ pnpm add @adbayb/stack --save-dev --workspace-root
 
 ### 2️⃣ Usage
 
-Create a `eslint.config.js` file and include the following:
+Create a `oxlint.config.ts` file and include the following:
 
 ```ts
-export { default } from "@adbayb/stack/eslint";
+export { default } from "@adbayb/stack/oxlint";
 ```
 
 <br />

package/configs/oxlint/index.ts

@@ -0,0 +1,319 @@
+import e18ePlugin from "@e18e/eslint-plugin";
+import { configs as perfectionistPlugin } from "eslint-plugin-perfectionist";
+import type { OxlintConfig } from "oxlint";
+import { defineConfig } from "oxlint";
+
+const JAVASCRIPT_EXTENSIONS = ["js", "jsx", "cjs", "mjs", "mjsx"];
+const JAVASCRIPT_EXTENSIONS_AS_STRING = JAVASCRIPT_EXTENSIONS.join(",");
+const JAVASCRIPT_FILES = [`**/*.{${JAVASCRIPT_EXTENSIONS_AS_STRING}}`];
+const TYPESCRIPT_EXTENSIONS = ["ts", "tsx", "cts", "mts", "mtsx"];
+const JAVASCRIPT_LIKE_EXTENSIONS = [...JAVASCRIPT_EXTENSIONS, ...TYPESCRIPT_EXTENSIONS];
+const JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING = JAVASCRIPT_LIKE_EXTENSIONS.join(",");
+
+const TEST_LIKE_FILES = [
+	`**/{test,test-d}.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+	`**/*.{test,test-d}.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+];
+
+const config = defineConfig({
+	categories: {
+		correctness: "error",
+		nursery: "error",
+		pedantic: "error",
+		perf: "error",
+		restriction: "error",
+		style: "error",
+		suspicious: "error",
+	},
+	jsPlugins: ["@e18e/eslint-plugin", "@stylistic/eslint-plugin", "eslint-plugin-perfectionist"],
+	options: {
+		denyWarnings: true,
+		reportUnusedDisableDirectives: "error",
+		respectEslintDisableDirectives: false,
+		typeAware: true,
+		typeCheck: true,
+	},
+	overrides: [
+		{
+			files: ["**/*.d.ts"],
+			rules: {
+				"unicorn/require-module-specifiers": "off",
+			},
+		},
+		{
+			files: JAVASCRIPT_FILES,
+			rules: {
+				// Following disabled rules are required until this issue is resolved https://github.com/oxc-project/oxc/issues/20073
+				"typescript/no-unsafe-assignment": "off",
+				"typescript/no-unsafe-call": "off",
+				"typescript/no-unsafe-member-access": "off",
+				"typescript/no-unsafe-return": "off",
+			},
+		},
+		{
+			files: TEST_LIKE_FILES,
+			plugins: ["vitest"],
+			rules: {
+				"vitest/consistent-test-it": ["error", { fn: "test", withinDescribe: "test" }],
+				"vitest/max-expects": "off",
+				"vitest/no-hooks": "off",
+				"vitest/no-importing-vitest-globals": "off",
+				"vitest/prefer-expect-assertions": "off",
+				"vitest/prefer-to-be-falsy": "off",
+				"vitest/prefer-to-be-truthy": "off",
+				"vitest/require-mock-type-parameters": "off",
+				"vitest/require-test-timeout": "off",
+				"vitest/valid-title": [
+					"error",
+					{ allowArguments: true, mustMatch: { test: ["^should "] } },
+				],
+			},
+		},
+		{
+			files: [
+				...TEST_LIKE_FILES,
+				"**/.config/**",
+				"**/.configs/**",
+				"**/config/**",
+				"**/configs/**",
+				"**/examples/**",
+				"**/scripts/**",
+				"**/tools/**",
+				`**/config.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+				`**/configs.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+				`**/*.config.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+				`**/*.configs.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+				`**/stories.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+				`**/*.stories.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+			],
+			rules: {
+				"e18e/prefer-static-regex": "off",
+				"import/no-anonymous-default-export": "off",
+				"import/no-default-export": "off",
+				"react/forbid-component-props": "off",
+			},
+		},
+	],
+	plugins: [
+		"eslint",
+		"import",
+		"jsdoc",
+		"jsx-a11y",
+		"node",
+		"oxc",
+		"promise",
+		"react",
+		// "react-perf", // is disabled because it flags patterns that are often harmless, its optimization rules don't align well with modern React performance guidance, it generates more noise than value, and we prefer profiling-driven optimizations over enforced manual optimizations.
+		"typescript",
+		"unicorn",
+	],
+	rules: {
+		...e18ePlugin.configs.recommended.rules,
+		...perfectionistPlugin["recommended-natural"].rules,
+		...Object.fromEntries(
+			[
+				"sort-export-attributes",
+				"sort-import-attributes",
+				"sort-interfaces",
+				"sort-jsx-props",
+				"sort-maps",
+				"sort-object-types",
+				"sort-objects",
+				"sort-union-types",
+				"sort-variable-declarations",
+			].map((ruleName) => {
+				return [
+					`perfectionist/${ruleName}`,
+					[
+						"error",
+						{
+							customGroups: [
+								{
+									elementNamePattern:
+										"^(as|children|id|identifier|htmlFor|key|ref)$",
+									groupName: "id-like",
+								},
+								{
+									elementNamePattern: "^(label|name|title)$",
+									groupName: "name-like",
+								},
+								{
+									elementNamePattern: "^(description|metadata)$",
+									groupName: "metadata-like",
+								},
+							],
+							groups: ["id-like", "name-like", "metadata-like", "unknown"],
+							type: "natural",
+						},
+					],
+				];
+			}),
+		),
+		"@stylistic/jsx-pascal-case": "error",
+		"@stylistic/jsx-self-closing-comp": "error",
+		"@stylistic/lines-between-class-members": "error",
+		"@stylistic/multiline-comment-style": "error",
+		"@stylistic/padded-blocks": ["error", "never"],
+		"@stylistic/padding-line-between-statements": [
+			"error",
+			// Default: separate everything.
+			{
+				blankLine: "always",
+				next: "*",
+				prev: "*",
+			},
+			// Keep single-line variable declarations together
+			{
+				blankLine: "never",
+				next: ["singleline-const", "singleline-let", "singleline-var"],
+				prev: ["singleline-const", "singleline-let", "singleline-var"],
+			},
+			// Keep single-line exports together
+			{
+				blankLine: "never",
+				next: ["singleline-export"],
+				prev: ["singleline-export"],
+			},
+			{
+				blankLine: "never",
+				next: ["cjs-export"],
+				prev: ["cjs-export"],
+			},
+			// Keep statements together
+			{
+				blankLine: "never",
+				next: ["singleline-expression"],
+				prev: ["singleline-expression"],
+			},
+			// Keep imports together.
+			{
+				blankLine: "never",
+				next: ["import"],
+				prev: ["import"],
+			},
+			{
+				blankLine: "never",
+				next: ["cjs-import"],
+				prev: ["cjs-import"],
+			},
+			// Keep directives together
+			{
+				blankLine: "never",
+				next: "directive",
+				prev: "directive",
+			},
+			// Keep switch labels together
+			{
+				blankLine: "never",
+				next: ["case", "default"],
+				prev: ["case", "default"],
+			},
+			{
+				blankLine: "never",
+				next: "*",
+				prev: ["case", "default"],
+			},
+		],
+		"@stylistic/quotes": [
+			"error",
+			"double",
+			{ allowTemplateLiterals: "avoidEscape", avoidEscape: true },
+		],
+		"@stylistic/spaced-comment": "error",
+		"arrow-body-style": ["error", "always"],
+		"class-methods-use-this": "off",
+		"id-length": "off",
+		"import/exports-last": "off",
+		"import/group-exports": "off",
+		"import/max-dependencies": "off",
+		"import/no-dynamic-require": "off",
+		"import/no-named-export": "off",
+		"import/no-nodejs-modules": "off",
+		"import/no-relative-parent-imports": "off",
+		"import/prefer-default-export": "off",
+		"import/unambiguous": "off",
+		"init-declarations": "off",
+		"jsdoc/require-param-type": "off",
+		"jsdoc/require-property-type": "off",
+		"jsdoc/require-returns-type": "off",
+		"max-classes-per-file": "off",
+		"max-lines": "off",
+		"max-lines-per-function": "off",
+		"max-params": "off",
+		"max-statements": "off",
+		"nextjs/google-font-display": "error",
+		"nextjs/google-font-preconnect": "error",
+		"nextjs/no-sync-scripts": "error",
+		"nextjs/no-unwanted-polyfillio": "error",
+		"no-async-await": "off",
+		"no-await-in-loop": "off",
+		"no-bitwise": "off",
+		"no-console": "off",
+		"no-continue": "off",
+		"no-duplicate-imports": ["error", { allowSeparateTypeImports: true }],
+		"no-inline-comments": "off",
+		"no-magic-numbers": "off",
+		"no-optional-chaining": "off",
+		"no-param-reassign": "off",
+		"no-plusplus": "off",
+		"no-rest-spread-properties": "off",
+		"no-ternary": "off",
+		"no-undef": "off",
+		"no-undefined": "off",
+		"no-underscore-dangle": "off",
+		"no-use-before-define": "off",
+		"no-useless-return": "off",
+		"no-void": "off",
+		"no-warning-comments": "off",
+		"node/no-process-env": "off",
+		"node/no-sync": "off",
+		"node/no-top-level-await": ["error", { ignoreBin: true }],
+		"oxc/no-async-endpoint-handlers": "off",
+		"perfectionist/sort-imports": "off", // Already supported by Oxfmt
+		"perfectionist/sort-named-imports": "off", // Already supported by eslint/sort-imports
+		"prefer-named-capture-group": "off",
+		"prefer-readonly-parameter-types": "off",
+		"promise/avoid-new": "off",
+		"react/function-component-definition": "off",
+		"react/jsx-filename-extension": ["error", { extensions: ["jsx", "tsx"] }],
+		"react/jsx-max-depth": "off",
+		"react/jsx-no-literals": "off",
+		"react/jsx-props-no-spreading": "off",
+		"react/no-multi-comp": "off",
+		"react/prefer-function-component": [
+			"error",
+			{ allowErrorBoundary: true, allowJsxUtilityClass: true },
+		],
+		"react/react-in-jsx-scope": "off",
+		"require-await": "off", // Already better covered by "typescript/require-await"
+		"sort-imports": "off", // Already supported by ESLint Perfectionist
+		"sort-keys": "off", // Already supported by ESLint Perfectionist
+		"sort-vars": "off", // Already supported by ESLint Perfectionist
+		"strict-boolean-expressions": "off",
+		"typescript/ban-types": "off", // Deprecated
+		"typescript/consistent-return": "off",
+		"typescript/consistent-type-definitions": ["error", "type"],
+		"typescript/explicit-function-return-type": "off",
+		"typescript/explicit-module-boundary-types": "off",
+		"typescript/no-unsafe-type-assertion": "off",
+		"typescript/non-nullable-type-assertion-style": "off",
+		"unicorn/filename-case": "off",
+		"unicorn/import-style": "off",
+		"unicorn/no-array-for-each": "off",
+		"unicorn/no-array-reduce": "off",
+		"unicorn/no-useless-switch-case": "off",
+		"unicorn/no-useless-undefined": "off",
+		"unicorn/prefer-math-trunc": "off", // No really identical replacement especially for `hash >>> 0` ensuring a positive integer
+	},
+});
+
+export const createConfig = ({
+	ignorePatterns,
+}: Required<Pick<OxlintConfig, "ignorePatterns">>): OxlintConfig => {
+	return {
+		...config,
+		ignorePatterns,
+	};
+};
+
+export default config;

package/configs/typescript/index.json

@@ -10,13 +10,7 @@
 		"exactOptionalPropertyTypes": true,
 		"incremental": true,
 		"jsx": "react-jsx",
-		"lib": [
-			"ESNext",
-			"DOM",
-			"DOM.AsyncIterable",
-			"DOM.Iterable",
-			"WebWorker.ImportScripts"
-		],
+		"lib": ["ESNext", "DOM", "DOM.AsyncIterable", "DOM.Iterable", "WebWorker.ImportScripts"],
 		"module": "Preserve",
 		"noEmit": true,
 		"noErrorTruncation": true,

package/dist/configs/oxfmt.d.ts

@@ -0,0 +1,32 @@
+import { OxfmtConfig } from "oxfmt";
+//#region configs/oxfmt/index.d.ts
+declare const config: {
+  arrowParens: "always";
+  bracketSameLine: false;
+  bracketSpacing: true;
+  embeddedLanguageFormatting: "auto";
+  endOfLine: "lf";
+  htmlWhitespaceSensitivity: "css";
+  ignorePatterns: never[];
+  insertFinalNewline: true;
+  jsdoc: true;
+  jsxSingleQuote: false;
+  objectWrap: "preserve";
+  printWidth: number;
+  proseWrap: "preserve";
+  quoteProps: "consistent";
+  semi: true;
+  singleAttributePerLine: true;
+  singleQuote: false;
+  sortImports: {
+    newlinesBetween: false;
+  };
+  sortPackageJson: true;
+  tabWidth: number;
+  trailingComma: "all";
+  useTabs: true;
+  vueIndentScriptAndStyle: false;
+};
+declare const createConfig: ({ overrides }: Required<Pick<OxfmtConfig, "overrides">>) => OxfmtConfig;
+//#endregion
+export { createConfig, config as default };

package/dist/configs/oxfmt.js

@@ -0,0 +1,37 @@
+import { defineConfig } from "oxfmt";
+
+//#region configs/oxfmt/index.ts
+const config = defineConfig({
+	arrowParens: "always",
+	bracketSameLine: false,
+	bracketSpacing: true,
+	embeddedLanguageFormatting: "auto",
+	endOfLine: "lf",
+	htmlWhitespaceSensitivity: "css",
+	ignorePatterns: [],
+	insertFinalNewline: true,
+	jsdoc: true,
+	jsxSingleQuote: false,
+	objectWrap: "preserve",
+	printWidth: 100,
+	proseWrap: "preserve",
+	quoteProps: "consistent",
+	semi: true,
+	singleAttributePerLine: true,
+	singleQuote: false,
+	sortImports: { newlinesBetween: false },
+	sortPackageJson: true,
+	tabWidth: 4,
+	trailingComma: "all",
+	useTabs: true,
+	vueIndentScriptAndStyle: false
+});
+const createConfig = ({ overrides }) => {
+	return {
+		...config,
+		overrides
+	};
+};
+
+//#endregion
+export { createConfig, config as default };