@kitschpatrol/cspell-config 1.0.1 → 2.0.0

package/cli.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env zx
+/* eslint-disable unicorn/prefer-module */
+import minimist from 'minimist';
+import { $, path } from 'zx';
+import 'zx/globals';
+
+await (async function main() {
+	const options = ['init', 'check'];
+	const args = minimist(process.argv.slice(2), {
+		boolean: options,
+	});
+
+	const argumentCount = options.reduce((count, argument) => count + (args[argument] ? 1 : 0), 0);
+	if (argumentCount !== 1) {
+		console.error(`[CSpell] Please provide exactly one of ${options.map((opt) => `--${opt}`).join(' or ')}`);
+		process.exit(1);
+	}
+
+	process.env.FORCE_COLOR = '1';
+	if (args.init) {
+		await $`cp -Ri ${path.join(__dirname, 'init')}/. ${process.cwd()}`.nothrow();
+	} else if (args.check) {
+		await $`cspell --quiet .`;
+	}
+})();

package/main.json

@@ -53,6 +53,7 @@
 		"linkedom",
 		"linkify",
 		"markdownit",
+		"markdownlint",
 		"Matheus",
 		"Matija",
 		"Menlo",
@@ -61,6 +62,7 @@
 		"Nikiforov",
 		"noopener",
 		"noreferrer",
+		"nothrow",
 		"pagefind",
 		"Palash",
 		"Panebuilder",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/cspell-config",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "type": "module",
   "description": "CSPell config for @kitschpatrol/shared-config",
   "repository": {
@@ -23,12 +23,16 @@
     "pnpm": ">=8.0.0"
   },
   "bin": {
-    "cspell-config-init": "./init.js"
+    "cspell-config": "./cli.js"
   },
   "main": "main.json",
   "peerDependencies": {
     "cspell": "^8.1.3"
   },
+  "dependencies": {
+    "minimist": "^1.2.8",
+    "zx": "^7.2.3"
+  },
   "publishConfig": {
     "access": "public"
   }

package/readme.md

@@ -25,19 +25,21 @@ To use just this CSpell config in isolation:
 3. Add the starter `.cspell.json` file to your project root, and add any customizations you'd like:
 
    ```sh
-   pnpm exec cspell-config-init
+   pnpm exec cspell-config --init
    ```
 
 ## Usage
 
 The CSpell binary should be picked up automatically by VSCode plugins.
 
+You can call it directly, or use the script bundled with the config.
+
 Integrate with your `package.json` scripts as you see fit, for example:
 
 ```json
 ...
 "scripts": {
-  "spellcheck": "cspell --quiet ."
+  "spellcheck": "cspell-config --check"
 }
 ...
 ```

package/init.js

@@ -1,22 +0,0 @@
-import console from 'node:console';
-import fs from 'node:fs';
-import path from 'node:path';
-import process from 'node:process';
-import { fileURLToPath } from 'node:url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-const sourceDirectory = path.join(__dirname, 'init');
-const destinationDirectory = process.cwd(); // (project root)
-
-for (const file of fs.readdirSync(sourceDirectory)) {
-	const sourcePath = path.join(sourceDirectory, file);
-	const destinationPath = path.join(destinationDirectory, file);
-
-	if (fs.existsSync(destinationPath)) {
-		console.log(`${file} already exists in project root, skipping.`);
-	} else {
-		fs.copyFileSync(sourcePath, destinationPath);
-		console.log(`Copied ${file} to project root.`);
-	}
-}