@adbayb/stack 2.40.0-next-d2a93ae → 2.40.0-next-9f3b748

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/configs/oxfmt/index.ts

@@ -1,6 +1,7 @@
+import type { OxfmtConfig } from "oxfmt";
 import { defineConfig } from "oxfmt";
 
-export default defineConfig({
+const config = defineConfig({
 	arrowParens: "always",
 	bracketSameLine: false,
 	bracketSpacing: true,
@@ -27,3 +28,12 @@ export default defineConfig({
 	useTabs: true,
 	vueIndentScriptAndStyle: false,
 });
+
+export const createConfig = (input: Required<Pick<OxfmtConfig, "overrides">>): OxfmtConfig => {
+	return {
+		...config,
+		...input,
+	};
+};
+
+export default config;

package/configs/oxlint/index.ts

@@ -1,3 +1,6 @@
+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"];
@@ -10,24 +13,7 @@ const TEST_LIKE_FILES = [
 	`**/*.{test,test-d}.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
 ];
 
-const RELAXED_LIKE_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}}`,
-];
-
-export default defineConfig({
+const config = defineConfig({
 	categories: {
 		correctness: "error",
 		nursery: "error",
@@ -37,6 +23,7 @@ export default defineConfig({
 		style: "error",
 		suspicious: "error",
 	},
+	jsPlugins: ["@e18e/eslint-plugin", "@stylistic/eslint-plugin", "eslint-plugin-perfectionist"],
 	options: {
 		denyWarnings: true,
 		reportUnusedDisableDirectives: "error",
@@ -51,8 +38,20 @@ export default defineConfig({
 		},
 		{
 			files: [
-				...RELAXED_LIKE_FILES,
-				`*.config(s)?.{${JAVASCRIPT_LIKE_EXTENSIONS_AS_STRING}}`,
+				...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: {
 				"import/no-anonymous-default-export": "off",
@@ -60,9 +59,7 @@ export default defineConfig({
 			},
 		},
 	],
-	// TODO: add jsPlugins for perfectionist and padding-line-between-statements + add React rules (such as set-state-in-effect) from React X https://github.com/oxc-project/oxc/issues/1022 + potentially https://github.com/es-tooling/eslint-plugin-depend/blob/main/docs/rules/ban-dependencies.md
 	plugins: [
-		// TODO: check perfectionist sorting here
 		"eslint",
 		"import",
 		"jsdoc",
@@ -76,6 +73,78 @@ export default defineConfig({
 		"unicorn",
 	],
 	rules: {
+		...e18ePlugin.configs.recommended.rules,
+		...perfectionistPlugin["recommended-natural"].rules,
+		"@stylistic/jsx-pascal-case": "error",
+		"@stylistic/jsx-self-closing-comp": "error",
+		"@stylistic/lines-between-class-members": "error",
+		"@stylistic/multiline-comment-style": "error",
+		"@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",
 		"array-callback-return": ["error", { allowImplicit: true }],
 		"arrow-body-style": ["error", "always"],
 		"id-length": "off",
@@ -99,7 +168,10 @@ export default defineConfig({
 		"nextjs/no-sync-scripts": "error",
 		"nextjs/no-unwanted-polyfillio": "error",
 		"no-async-await": "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-rest-spread-properties": "off",
@@ -110,6 +182,8 @@ export default defineConfig({
 		"no-void": "off",
 		"no-warning-comments": "off",
 		"node/no-sync": "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",
 		"react/jsx-max-depth": "off",
@@ -124,3 +198,14 @@ export default defineConfig({
 		"unicorn/import-style": "off",
 	},
 });
+
+export const createConfig = (
+	input: Required<Pick<OxlintConfig, "ignorePatterns">>,
+): OxlintConfig => {
+	return {
+		...config,
+		...input,
+	};
+};
+
+export default config;

package/dist/index.js

@@ -93,16 +93,14 @@ const setPackageManager = async () => {
 	*/
 	await helpers.exec("pnx corepack enable");
 };
-async function getRequest(url, responseType) {
+const request = { async get(url, responseType) {
 	const response = await fetch(url);
 	if (!response.ok) throw createError("fetch", `Failed to fetch resources from ${url} (${JSON.stringify({
 		status: response.status,
 		statusText: response.statusText
 	})})`);
-	if (responseType === "text") return response.text();
-	return response.json();
-}
-const request = { get: getRequest };
+	return responseType === "text" ? response.text() : response.json();
+} };
 const oxlint = (options) => {
 	return async (files = []) => {
 		const args = [
@@ -110,7 +108,7 @@ const oxlint = (options) => {
 			"--disable-nested-config",
 			"--no-error-on-unmatched-pattern"
 		];
-		if (options.isFixMode) args.push("--fix");
+		if (options.isFixMode) args.push("--fix-dangerously");
 		try {
 			return await helpers.exec(`oxlint ${args.join(" ")}`);
 		} catch (error) {
@@ -221,13 +219,14 @@ const checkDependency = async () => {
 		checkDependencyVersionRange(pkg);
 	}
 };
+const STARTING_WITH_DIGIT_REGEXP = /^\d/u;
 const checkDependencyVersionRange = ({ dependencies, devDependencies, name, peerDependencies }) => {
 	for (const [dependencyName, version] of Object.entries(devDependencies)) {
 		assertVersion(version, {
 			consumedBy: name,
 			name: dependencyName
 		});
-		if (version !== "workspace:*" && !isExcluded(version) && !/^\d/u.test(version)) throw createPackageError(`As a dev dependency, \`${dependencyName}\` version must be fixed (or set as "workspace:*" for local packages) to reduce accidental breaking change risks due to an implicit semver upgrade.`, {
+		if (version !== "workspace:*" && !isExcluded(version) && !STARTING_WITH_DIGIT_REGEXP.test(version)) throw createPackageError(`As a dev dependency, \`${dependencyName}\` version must be fixed (or set as "workspace:*" for local packages) to reduce accidental breaking change risks due to an implicit semver upgrade.`, {
 			consumedBy: name,
 			name: dependencyName
 		});
@@ -290,8 +289,9 @@ const assertVersion = (version, { consumedBy, name }) => {
 		});
 	});
 };
+const PRERELEASE_VERSION_REGEXP = /\d+\.\d+\.\d+-(alpha|beta|experimental|next|rc).*/u;
 const isExcluded = (version) => {
-	const isPreReleaseVersion = /\d+\.\d+\.\d+-(alpha|beta|experimental|next|rc).*/u.exec(version);
+	const isPreReleaseVersion = PRERELEASE_VERSION_REGEXP.exec(version);
 	return version.startsWith("npm:") || isPreReleaseVersion;
 };
 const hasCaret = (version) => {
@@ -427,8 +427,9 @@ const cleanFiles = async (files) => {
 const isDirectoryExistAndNotEmpty = (path) => {
 	return existsSync(path) && readdirSync(path).length > 0;
 };
+const LINEBREAK_REGEXP = /\n|\r\n/u;
 const retrieveIgnoredFiles = async () => {
-	return (await helpers.exec("git clean -fdXn")).split(/\n|\r\n/u).filter((cleanOutput) => {
+	return (await helpers.exec("git clean -fdXn")).split(LINEBREAK_REGEXP).filter((cleanOutput) => {
 		return PRESERVE_FILES.every((excludedFile) => {
 			return !cleanOutput.includes(excludedFile);
 		});
@@ -440,10 +441,11 @@ const PRESERVE_FILES = ["node_modules"];
 
 //#endregion
 //#region package.json
-var version = "2.40.0-next-d2a93ae";
+var version = "2.40.0-next-9f3b748";
 
 //#endregion
 //#region src/commands/create.ts
+const REPOSITORY_REGEXP = /^(?:git@.*:|https?:\/\/.*\/)(?<repoOwner>[^/]+)\/(?<repoName>[^/]+)\.git$/u;
 const createCreateCommand = (program) => {
 	program.command({
 		description: "Scaffold a new project",
@@ -481,7 +483,7 @@ const createCreateCommand = (program) => {
 	}).task({
 		async handler({ inputDescription, inputName, inputTemplate, inputUrl }) {
 			if (!inputName) throw createError("stack create", "The project name is not optional. Make sure to provide a valid value (non-empty string).");
-			const { repoName, repoOwner } = (inputUrl.startsWith("git") ? /^git@.*:(?<repoOwner>.*)\/(?<repoName>.*)\.git$/u : /^https?:\/\/.*\/(?<repoOwner>.*)\/(?<repoName>.*)\.git$/u).exec(inputUrl)?.groups ?? {};
+			const { repoName, repoOwner } = REPOSITORY_REGEXP.exec(inputUrl)?.groups ?? {};
 			if (!repoOwner || !repoName) throw createError("git", "The owner and repository name can not be extracted. Please make sure to follow either `/^git@.*:(?<repoOwner>.*)/(?<repoName>.*).git$/` or `/^https?://.*/(?<repoOwner>.*)/(?<repoName>.*).git$/` pattern.");
 			const nodeVersion = await request.get("https://resolve-node.vercel.app/lts", "text");
 			const { version: pnpmVersion } = await request.get("https://registry.npmjs.org/pnpm/latest", "json");
@@ -607,8 +609,6 @@ const createTemplateEngine = async (workingPath, { projectName, templateModel, t
 	});
 	const gitignoreFile = join(workingPath, ".gitignore.tmpl");
 	if (existsSync(gitignoreFile)) await rename(gitignoreFile, join(workingPath, ".gitignore"));
-	const eslintConfigFile = join(workingPath, "eslint.config.js.tmpl");
-	if (existsSync(eslintConfigFile)) await rename(eslintConfigFile, join(workingPath, "eslint.config.js"));
 	const templateEntries = await getTemplateEntries(workingPath);
 	process.chdir(workingPath);
 	return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adbayb/stack",
-  "version": "2.40.0-next-d2a93ae",
+  "version": "2.40.0-next-9f3b748",
   "description": "My opinionated JavaScript-based toolchain",
   "keywords": [
     "development",
@@ -47,6 +47,9 @@
     "@changesets/cli": "^2.31.0",
     "@commitlint/cli": "^21.2.1",
     "@commitlint/config-conventional": "^21.2.0",
+    "@e18e/eslint-plugin": "^0.5.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "eslint-plugin-perfectionist": "^5.10.0",
     "oxfmt": "^0.58.0",
     "oxlint": "^1.73.0",
     "oxlint-tsgolint": "^0.24.0",

package/templates/multi-projects/oxfmt.config.ts

@@ -0,0 +1 @@
+export { default } from "@adbayb/stack/oxfmt";

package/templates/multi-projects/oxlint.config.ts

@@ -0,0 +1 @@
+export { default } from "@adbayb/stack/oxlint";

package/templates/single-project/oxfmt.config.ts

@@ -0,0 +1 @@
+export { default } from "@adbayb/stack/oxfmt";

package/templates/single-project/oxlint.config.ts

@@ -0,0 +1 @@
+export { default } from "@adbayb/stack/oxlint";

package/templates/multi-projects/eslint.config.js.tmpl

@@ -1 +0,0 @@
-export { default } from "@adbayb/stack/eslint";

package/templates/single-project/eslint.config.js.tmpl

@@ -1 +0,0 @@
-export { default } from "@adbayb/stack/eslint";