🎨 Reformat README (#5)

Reformats README with sentence-based line breaks. Replaces Prettier config file with `.editorconfig`. Adds early version of functional form for export alongside default export.
connorjs · May 27, 2024 · d192257 · d192257
1 parent 160ea33
commit d192257
Show file tree

Hide file tree

Showing 8 changed files with 224 additions and 245 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,7 @@
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+# https://alexandersandberg.com/articles/default-to-tabs-instead-of-spaces-for-an-accessible-first-environment/
+indent_style = tab
+insert_final_newline = true
diff --git a/README.md b/README.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "eslint-config-connorjs",
-	"version": "1.0.0-alpha.8",
+	"version": "1.0.0-alpha.9",
 	"description": "My (@connorjs) preferred ESLint configuration. With ESLint flat config.",
 	"keywords": [
 		"eslint",

diff --git a/prettier.config.cjs b/prettier.config.cjs
diff --git a/src/export.js b/src/export.js
@@ -10,14 +10,32 @@ import { react } from "./react.js";
  *
  * @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigFile}
  */
-const config = [
+const connorjsConfig = [
 	...javascriptAndTypescript,
 	...react,
-	...json,
+	...json({ packageJson: true }),
 	...html,
-	...graphql,
 	...base, // Last to apply to all file types
 ];
 
 // eslint-disable-next-line import/no-default-export -- ESLint configs use default export (community practice)
-export default config;
+export default connorjsConfig;
+
+/**
+ * Creates a custom `@connorjs` ESLint config.
+ *
+ * @param options - Configuration options.
+ * @param options.html {boolean=true} - Enables HTML.
+ * @param options.graphql {boolean=false} - Enables GraphQL.
+ * @param options.packageJson {boolean=true} - Applies `package.json` sorting rules.
+ */
+export function createConnorjsConfig(options = {}) {
+	return [
+		...javascriptAndTypescript,
+		...react,
+		...json({ packageJson: options.packageJson ?? true }),
+		...(options.html ?? true ? html : []),
+		...(options.graphql ? graphql : []),
+		...base, // Last to apply to all file types
+	];
+}
diff --git a/src/javascript-and-typescript.js b/src/javascript-and-typescript.js
@@ -68,8 +68,7 @@ export const javascriptAndTypescript = tseslint.config(
 				{
 					/* eslint-disable unicorn/string-content -- Configuring this rule */
 					patterns: {
-						// The quote items can cause controversy, so I’ve
-						// commented out by default.
+						// The quote items can cause controversy, so I’ve commented out by default.
 						//
 						// '"': {
 						// 	fix: false, // Should not fix quotes

diff --git a/src/json.js b/src/json.js
@@ -2,90 +2,95 @@ import jsoncPlugin from "eslint-plugin-jsonc";
 import jsoncParser from "jsonc-eslint-parser";
 import tseslint from "typescript-eslint";
 
-export const json = tseslint.config(
-	{
-		// JSON files
-		files: [`**/*.{json,jsonc}`],
-		ignores: [`package-lock.json`],
-		languageOptions: {
-			parser: jsoncParser,
+export function json(options = {}) {
+	const config = tseslint.config(
+		{
+			// JSON files
+			files: [`**/*.{json,jsonc}`],
+			ignores: [`package-lock.json`],
+			languageOptions: {
+				parser: jsoncParser,
+			},
+			plugins: { jsonc: jsoncPlugin },
+			rules: {
+				...jsoncPlugin.configs[`recommended-with-json`].rules,
+				...jsoncPlugin.configs.prettier.rules,
+				"jsonc/sort-keys": `error`, // Specify per-file orders as needed (below)
+			},
 		},
-		plugins: { jsonc: jsoncPlugin },
-		rules: {
-			...jsoncPlugin.configs[`recommended-with-json`].rules,
-			...jsoncPlugin.configs.prettier.rules,
-			"jsonc/sort-keys": `error`, // Specify per-file orders as needed (below)
+		{
+			// These allow comments (a.k.a. JSONC files)
+			files: [
+				`**/global.json`,
+				`**/tsconfig*.json`,
+				`**/turbo.json`,
+				`**/*.jsonc`,
+			],
+			rules: { "jsonc/no-comments": `off` },
 		},
-	},
-	{
-		// These allow comments (a.k.a. JSONC files)
-		files: [
-			`**/global.json`,
-			`**/tsconfig*.json`,
-			`**/turbo.json`,
-			`**/*.jsonc`,
-		],
-		rules: { "jsonc/no-comments": `off` },
-	},
-	{
-		// Special rules for package.json
-		files: [`**/package.json`],
-		rules: {
-			"jsonc/sort-keys": [
-				`warn`, // warn because nothing is “wrong” and this config may change often
-				{
-					// Defines order of root properties
-					order: [
-						`name`,
-						`version`,
-						`description`,
-						`private`,
+	);
+	if (options.packageJson) {
+		config.push({
+			// Special rules for package.json
+			files: [`**/package.json`],
+			rules: {
+				"jsonc/sort-keys": [
+					`warn`, // warn because nothing is “wrong” and this config may change often
+					{
+						// Defines order of root properties
+						order: [
+							`name`,
+							`version`,
+							`description`,
+							`private`,
 
-						// Additional publish info
-						`keywords`,
-						`homepage`,
-						`bugs`,
-						`license`,
-						`author`,
-						`repository`,
-						`publishConfig`,
-						// End publish info
+							// Additional publish info
+							`keywords`,
+							`homepage`,
+							`bugs`,
+							`license`,
+							`author`,
+							`repository`,
+							`publishConfig`,
+							// End publish info
 
-						`type`,
-						`engines`, // Often used for ESM, so relates to `type`
+							`type`,
+							`engines`, // Often used for ESM, so relates to `type`
 
-						// Export fields
-						`bin`,
-						`directories`,
-						`files`,
-						`exports`,
-						// End export fields
+							// Export fields
+							`bin`,
+							`directories`,
+							`files`,
+							`exports`,
+							// End export fields
 
-						`scripts`,
-						// Tool-specific directly after scripts, alphabetical
-						`browserslist`,
-						`eslint`,
-						`lint-staged`,
-						// End tool-specific
+							`scripts`,
+							// Tool-specific directly after scripts, alphabetical
+							`browserslist`,
+							`eslint`,
+							`lint-staged`,
+							// End tool-specific
 
-						// Dependency related, specific order
-						`engineStrict`,
-						`overrides`, // Overrides before dependencies to emphasize their existence
-						`optionalDependencies`,
-						`peerDependencies`,
-						`peerDependenciesMeta`,
-						`dependencies`,
-						`devDependencies`,
-						// End dependency related
+							// Dependency related, specific order
+							`engineStrict`,
+							`overrides`, // Overrides before dependencies to emphasize their existence
+							`optionalDependencies`,
+							`peerDependencies`,
+							`peerDependenciesMeta`,
+							`dependencies`,
+							`devDependencies`,
+							// End dependency related
 
-						`workspaces`,
-						{ order: { type: `desc` } }, // Force other properties to go last
-					],
-					pathPattern: `^$`,
-				},
-				// Reinstate normal order for non-root properties
-				{ order: { type: `asc` }, pathPattern: `.*` },
-			],
-		},
-	},
-);
+							`workspaces`,
+							{ order: { type: `desc` } }, // Force other properties to go last
+						],
+						pathPattern: `^$`,
+					},
+					// Reinstate normal order for non-root properties
+					{ order: { type: `asc` }, pathPattern: `.*` },
+				],
+			},
+		});
+	}
+	return config;
+}