@atomicsmash/coding-standards 1.0.0

package/.eslintrc.cjs

@@ -0,0 +1,5 @@
+const eslintConfig = require("@atomicsmash/coding-standards").eslintConfig;
+module.exports = {
+	...eslintConfig,
+	ignorePatterns: [...(eslintConfig.ignorePatterns ?? []), "**/*.d.ts"],
+};

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @atomicsmash/coding-standards
+
+## 1.0.0
+
+### Major Changes
+
+- [`cf2e7f5`](https://github.com/AtomicSmash/packages/commit/cf2e7f590af7aa404a053e7490743b5cb0af3401) - First release of coding standards

package/browserslist/index.js

@@ -0,0 +1 @@
+module.exports = ["defaults and >1% and not samsung > 0 and not op_mini all"];

package/commitlint/index.js

@@ -0,0 +1 @@
+module.exports = { extends: ["@commitlint/config-conventional"] };

package/cspell/index.js

@@ -0,0 +1,79 @@
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * Search for `package.json`
+ * @param {string} from - search `from` directory.
+ * @returns {string|void} - path to package.json
+ */
+function findNearestPackageJson(from) {
+	from = path.resolve(from);
+	const parent = path.dirname(from);
+	if (!from || parent === from) {
+		return;
+	}
+
+	const pkg = path.join(from, "package.json");
+	if (fs.existsSync(pkg)) {
+		return pkg;
+	}
+	return findNearestPackageJson(parent);
+}
+
+/**
+ * Load the nearest package.json
+ * @param {string} cwd
+ * @returns
+ */
+function loadPackage(cwd) {
+	const pkgFile = findNearestPackageJson(cwd);
+	if (!pkgFile) return;
+	return JSON.parse(fs.readFileSync(pkgFile, "utf-8"));
+}
+
+function determinePackageNamesAndMethods(cwd = process.cwd()) {
+	const packageImport = loadPackage(cwd) || {};
+	const packageNames = Object.keys(packageImport.dependencies || {}).concat(
+		Object.keys(packageImport.devDependencies || {}),
+	);
+	return { packageNames };
+}
+
+/** @type { import("@cspell/cspell-types").CSpellUserSettings } */
+const config = {
+	language: "en-GB",
+	words: [
+		...determinePackageNamesAndMethods().packageNames,
+		"atomicsmash",
+		"commitlint",
+		"tsbuildinfo",
+		"sass",
+	],
+	languageSettings: [
+		{
+			languageId: "*",
+			locale: "en-GB",
+		},
+		{
+			languageId: "css, less, scss, sass",
+			locale: "en-US",
+			dictionaries: ["css"],
+		},
+		{
+			languageId: "javascript,typescript,javascriptreact,typescriptreact",
+			locale: "en-GB",
+			dictionaries: ["typescript"],
+		},
+		{
+			languageId: "php",
+			locale: "en-GB",
+			dictionaries: ["php", "html"],
+		},
+		{
+			languageId: "html,vue-html,javascriptreact,typescriptreact",
+			locale: "en-GB",
+			dictionaries: ["html"],
+		},
+	],
+};
+module.exports = config;

package/eslint/index.js

@@ -0,0 +1,64 @@
+module.exports = {
+	ignorePatterns: [".eslintrc.cjs", "dist/**/*", "**/*.config.*"],
+	plugins: ["import"],
+	extends: ["eslint:recommended", "prettier"],
+	env: {
+		browser: true,
+		commonjs: true,
+		node: true,
+		es2017: true,
+	},
+	rules: {
+		"no-case-declarations": ["off"],
+		"import/order": [
+			"error",
+			{
+				alphabetize: {
+					order: "asc",
+				},
+				groups: [
+					"type",
+					"builtin",
+					"external",
+					"internal",
+					"parent",
+					["sibling", "index"],
+				],
+				"newlines-between": "ignore",
+				pathGroups: [],
+				pathGroupsExcludedImportTypes: [],
+			},
+		],
+		"prefer-const": ["error"],
+		"no-var": ["error"],
+		"import/no-duplicates": "warn",
+	},
+	overrides: [
+		{
+			files: ["*.ts", "*.tsx", "*.mts", "*.cts"],
+			parser: "@typescript-eslint/parser",
+			plugins: ["@typescript-eslint", "import"],
+			extends: [
+				"eslint:recommended",
+				"plugin:@typescript-eslint/recommended",
+				"plugin:@typescript-eslint/recommended-requiring-type-checking",
+				"plugin:import/typescript",
+				"prettier",
+			],
+			rules: {
+				"@typescript-eslint/naming-convention": [
+					"error",
+					{ selector: "variableLike", format: ["camelCase"] },
+					{ selector: "function", format: ["camelCase", "PascalCase"] },
+					{ selector: "typeLike", format: ["PascalCase"] },
+					{
+						selector: "variable",
+						types: ["boolean"],
+						format: ["PascalCase"],
+						prefix: ["is", "should", "has", "can", "did", "will"],
+					},
+				],
+			},
+		},
+	],
+};

package/index.d.ts

@@ -0,0 +1,5 @@
+export const browserslistConfig: import("browserslist").Config;
+export const commitlintConfig: import("@commitlint/types").UserConfig;
+export const cspellConfig: import("@cspell/cspell-types").CSpellUserSettings;
+export const eslintConfig: import("eslint").Linter.Config;
+export const prettierConfig: import("prettier").Config;

package/index.js

@@ -0,0 +1,7 @@
+module.exports = {
+	browserslistConfig: require("./browserslist"),
+	commitlintConfig: require("./commitlint"),
+	cspellConfig: require("./cspell"),
+	eslintConfig: require("./eslint"),
+	prettierConfig: require("./prettier"),
+};

package/package.json

@@ -0,0 +1,54 @@
+{
+	"name": "@atomicsmash/coding-standards",
+	"version": "1.0.0",
+	"description": "A collection of coding standards configurations.",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"dependencies": {
+		"eslint": "^8.20.0",
+		"@commitlint/cli": "^17.0.3",
+		"@commitlint/config-conventional": "^17.0.3",
+		"prettier": "^2.7.1",
+		"@typescript-eslint/eslint-plugin": "^5.31.0",
+		"@typescript-eslint/parser": "^5.31.0",
+		"eslint-config-prettier": "^8.5.0",
+		"eslint-import-resolver-typescript": "^3.3.0",
+		"eslint-plugin-import": "^2.26.0"
+	},
+	"devDependencies": {
+		"browserslist": "^4.21.5",
+		"@cspell/cspell-types": "^6.18.1"
+	},
+	"bundledDependencies": [
+		"@commitlint/cli",
+		"@commitlint/config-conventional",
+		"eslint",
+		"eslint-config-prettier",
+		"eslint-import-resolver-typescript",
+		"eslint-plugin-import",
+		"prettier",
+		"@typescript-eslint/eslint-plugin",
+		"@typescript-eslint/parser"
+	],
+	"keywords": [
+		"atomic",
+		"smash",
+		"coding",
+		"standards"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/AtomicSmash/packages",
+		"directory": "packages/coding-standards"
+	},
+	"homepage": "https://www.atomicsmash.co.uk/",
+	"license": "GPL-3.0-or-later",
+	"author": {
+		"name": "Atomic Smash",
+		"email": "npm@atomicsmash.co.uk",
+		"url": "https://www.atomicsmash.co.uk/"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

package/prettier/index.js

@@ -0,0 +1,24 @@
+module.exports = {
+	/* Expected defaults:
+	Prettier recommendation
+	printWidth: 80,
+
+	Single quotes are more often found in text strings (used for apostrophes) so using double quotes prevents lots of escaping characters.
+	singleQuote: false,
+
+	Keep very nested indentation near the left to prevent lots of horizontal scrolling.
+	tabWidth: 2,
+
+	Semicolons prevent AST errors and are more explicit where a line ends
+	semi: true,
+	
+	Consistent line endings for MacOS and Windows
+	endOfLine: "lf",
+	*/
+
+	// Tabs are better for visually impaired coders https://www.reddit.com/r/javascript/comments/c8drjo/nobody_talks_about_the_real_reason_to_use_tabs/
+	useTabs: true,
+
+	// Helps clean up git diffs by removing changes of a single comma on a line if adding a new line to the bottom
+	trailingComma: "all",
+};

package/typescript/base-and-cypress.json

@@ -0,0 +1,17 @@
+{
+	"extends": "./base",
+	"exclude": [
+		"../node_modules/@types/jest",
+		"../node_modules/@testing-library/jest-dom"
+	],
+	"include": [
+		"e2e/**/*",
+		"support/**/*",
+		"../node_modules/cypress",
+		"../node_modules/@testing-library/cypress"
+	],
+	"compilerOptions": {
+		"types": ["node", "cypress", "@testing-library/cypress"],
+		"typeRoots": ["../types", "../node_modules/@types"]
+	}
+}

package/typescript/base-and-vitest.json

@@ -0,0 +1,7 @@
+{
+	"extends": "./base",
+	"exclude": ["./cypress", "./cypress.config.ts"],
+	"compilerOptions": {
+		"types": ["vitest/globals"]
+	}
+}

package/typescript/base.json

@@ -0,0 +1,16 @@
+{
+	"compilerOptions": {
+		"isolatedModules": true,
+		"esModuleInterop": true,
+		"moduleResolution": "node",
+		"resolveJsonModule": true,
+		"target": "es2020",
+		"module": "es2020",
+		"strict": true,
+		"allowJs": true,
+		"checkJs": true,
+		"forceConsistentCasingInFileNames": true,
+		"skipLibCheck": true,
+		"noEmit": true
+	}
+}