@kitschpatrol/shared-config 6.0.1 → 6.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/cli.js +11 -11
- package/package.json +10 -10
package/bin/cli.js
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{cosmiconfig as e}from"cosmiconfig";import{TypeScriptLoader as t}from"cosmiconfig-typescript-loader";import{execa as n}from"execa";import r from"fs-extra";import i,{constants as a}from"node:fs";import o from"node:path";import{PassThrough as s,Transform as c}from"node:stream";import{fileURLToPath as l}from"node:url";import{packageUp as u,packageUpSync as d}from"package-up";import f from"picocolors";import p from"yargs";import{hideBin as m}from"yargs/helpers";import h from"@pinojs/json-colorizer";import g from"decircular";import ee from"deepmerge";import te from"json-stringify-pretty-compact";import{findWorkspaces as ne,findWorkspacesRoot as _}from"find-workspaces";import v,{access as re}from"node:fs/promises";import{getDefaultConfigLoader as y,resolveConfigFileImports as b}from"cspell-lib";import{stripVTControlCharacters as ie}from"node:util";import{lint as ae}from"cspell";import"deepmerge-ts";import{loadConfig as oe,loadConfigReadme as se}from"mdat";import{globby as ce}from"globby";import
|
|
2
|
+
import{cosmiconfig as e}from"cosmiconfig";import{TypeScriptLoader as t}from"cosmiconfig-typescript-loader";import{execa as n}from"execa";import r from"fs-extra";import i,{constants as a}from"node:fs";import o from"node:path";import{PassThrough as s,Transform as c}from"node:stream";import{fileURLToPath as l}from"node:url";import{packageUp as u,packageUpSync as d}from"package-up";import f from"picocolors";import p from"yargs";import{hideBin as m}from"yargs/helpers";import h from"@pinojs/json-colorizer";import g from"decircular";import ee from"deepmerge";import te from"json-stringify-pretty-compact";import{findWorkspaces as ne,findWorkspacesRoot as _}from"find-workspaces";import v,{access as re}from"node:fs/promises";import{getDefaultConfigLoader as y,resolveConfigFileImports as b}from"cspell-lib";import{stripVTControlCharacters as ie}from"node:util";import{lint as ae}from"cspell";import"deepmerge-ts";import{loadConfig as oe,loadConfigReadme as se}from"mdat";import{globby as ce}from"globby";import x,{gt as S,minVersion as le}from"semver";import{readWantedLockfile as ue}from"@pnpm/lockfile.fs";import de from"stylelint";var fe=`6.0.2`;function pe(e){return e instanceof Error&&`exitCode`in e&&typeof e.exitCode==`number`}function C(e){return h(te(g(e),{indent:2,replacer(e,t){return typeof t==`function`?t.name:t}}),{colors:{BRACKET:`gray`}})}const me=(e,t,n)=>{let r=[...e];for(let[i,a]of t.entries())r[i]===void 0?r[i]=n.cloneUnlessOtherwiseSpecified(a,n):n.isMergeableObject(a)?r[i]=w(e[i],a,n):e.includes(a)||r.push(a);return r};function w(e,t,n={arrayMerge:me}){return ee(e,t,n)}function he(e,t){return e.startsWith(t+o.sep)}function T(){let e=E(),t=new Set([e]),n=ne();if(n!==null)for(let r of n)he(r.location,e)&&t.add(r.location);return[...t]}function E(){let e=d();if(e===void 0)throw Error(`No package.json found.`);return o.dirname(e)}function ge(){return _()!==null}function D(){let e=_();return e===null?E():e.location}function O(e){let t=o.join(D(),e);if(r.existsSync(t))return t}function k(e){if(e===`workspace-root`)return D();if(e===`package-dir`)return E();if(typeof e==`string`){if(!r.pathExistsSync(e))throw Error(`Custom cwd directory does not exist: ${e}`);return e}return process.cwd()}async function _e(e,t){try{let{default:n}=await import(`prettier`),r=await n.resolveConfig(e),i=await n.format(t,{filepath:e,...r});await v.writeFile(e,i,`utf8`)}catch{console.warn(`Skipped formatting ${e} since Prettier is not installed.`)}}async function A(e){try{await _e(e,await v.readFile(e,`utf8`))}catch{}}function ve(e){return new c({transform(t,n,r){let i=t.toString().split(/\r?\n/).filter(t=>t.trim()!==``&&!e(t)).join(`
|
|
3
3
|
`);this.push(i+`
|
|
4
|
-
`),r()}})}function
|
|
5
|
-
`);for(let e of t)c.write(`${e}\n`)}o=e.exitCode??1}catch(e){console.error(`${i.name} failed with error:`),console.error(e),
|
|
6
|
-
`),1;let d=o.join(o.dirname(c),`init`),f=o.dirname(s),p=(t===`file`||t===`package`)&&n!==void 0&&a!==void 0;try{if(p){let n=Object.keys(a)[0];if(t===`package`){let t=r.readJsonSync(s);e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let i=
|
|
7
|
-
`),0;let o=
|
|
8
|
-
`);for(let e of o)t.write(`${e}\n`);return 0},name:`Cosmiconfig ${e}`}}async function
|
|
9
|
-
`);for(let t of n)e.write(`${t}\n`);return 0}const
|
|
10
|
-
`);for(let t of r)e.write(`${t}\n`);return 0}async function B(e){let t=
|
|
11
|
-
`);for(let n of t)e.write(`${n}\n`);return 0}async function
|
|
12
|
-
`),0;e.write(`Found ${n} configuration at "${i}"\n`);let s;t.length>0?(s=o.join(process.cwd(),t[0]),e.write(`Showing config for file at "${s}"\n`)):s=
|
|
13
|
-
`);for(let t of c)e.write(`${t}\n`);return 0}const
|
|
4
|
+
`),r()}})}function j(e,t){return new c({transform(n,r,i){let a=n.toString().split(/\r?\n/).filter(e=>e.trim().length>0).map(n=>`${e?t===void 0?e:f[t](e):``} ${n}\n`).join(``);this.push(a),i()}})}async function ye(e){let t=[];return new Promise((n,r)=>{e.on(`data`,e=>t.push(e)),e.on(`error`,e=>{r(e)}),e.on(`end`,()=>{n(Buffer.concat(t).toString(`utf8`))})})}function be(e){return e.replaceAll(/[A-Z\u00C0-\u00D6\u00D8-\u00DE]/g,e=>`-`+e.toLowerCase())}function M(e,t){return t===1?e:e+`s`}async function xe(e,t,n,r,i){let a=1,o;if(r.logPrefix===void 0)o=e;else{let t=j(r.logPrefix,r.logColor);t.pipe(e),o=t}i&&o.write(f.bold(`Running: "${r.name}() with Positional arguments: ${String(t)} and Option flags: ${String(n)}"`));try{a=await r.execute(o,t,n)}catch(e){console.error(String(e)),a=1}return a}async function Se(e,t,r,i,a){let o=1,c;if(i.logPrefix===void 0)c=e;else{let t=j(i.logPrefix,i.logColor);t.pipe(e),c=t}let l=i.subcommands??[],u=[...i.receivePositionalArguments?t:[],...i.positionalArguments??[]],d=[...i.receiveOptionFlags?r:[],...i.optionFlags??[]],f=[...l,...d,...u],p=k(i.cwdOverride);a&&c.write(`Running: "${i.name} ${f.join(` `)}"`);let m=i.prettyJsonOutput?new s:c;try{let e=n(i.name,f,{cwd:p,env:{...process.env.NO_COLOR===void 0?{FORCE_COLOR:`true`}:{}},preferLocal:!0,reject:!1,stdin:`inherit`});if(e.stdout.pipe(m,{end:!1}),e.stderr.pipe(m,{end:!1}),await e,i.prettyJsonOutput){m.end();let e=await ye(m),t=C(JSON.parse(e)).split(`
|
|
5
|
+
`);for(let e of t)c.write(`${e}\n`)}o=e.exitCode??1}catch(e){console.error(`${i.name} failed with error:`),console.error(e),pe(e)&&(o=typeof e.exitCode==`number`?e.exitCode:1)}return o}function Ce(e){return`execute`in e}async function N(e,t,n,r,i,a){let o=[];for(let a of r){let r=await(Ce(a)?xe(e,t,n,a,i):Se(e,t,n,a,i));o.push({exitCode:r,name:a.name})}if(a){let t=o.filter(({exitCode:e})=>e===0).map(({name:e})=>e),n=o.filter(({exitCode:e})=>e!==0).map(({name:e})=>e),r=o.length;t.length>0&&e.write(`✅ ${f.green(f.bold(`${t.length} / ${r} ${M(`Command`,t.length)} Succeeded:`))} ${f.green(t.join(`, `))}\n`),n.length>0&&e.write(`❌ ${f.red(f.bold(`${n.length} / ${r} ${M(`Command`,n.length)} Failed:`))} ${f.red(n.join(`, `))}\n`)}return o.every(({exitCode:e})=>e===0)?0:1}async function we(e,t,n,a){let s=await u();if(s===void 0)throw Error("The `init` command must be used in a directory with a package.json file");let c=await u({cwd:l(import.meta.url)});if(c===void 0)return e.write(`Error: The script being called was not in a package, weird.
|
|
6
|
+
`),1;let d=o.join(o.dirname(c),`init`),f=o.dirname(s),p=(t===`file`||t===`package`)&&n!==void 0&&a!==void 0;try{if(p){let n=Object.keys(a)[0];if(t===`package`){let t=r.readJsonSync(s);e.write(`Merging: \nPackage config key "${n}" → "${f}" (Because --location is set to "package")\n`);let i=w(t,a);r.writeJSONSync(s,i,{spaces:` `}),await A(s)}else{let t=r.readJsonSync(s);Object.keys(t).includes(n)&&(e.write(`Deleting: \nPackage config key "${n}" in "${f}" (Because --location is set to "file")\n`),delete t[n],r.writeJSONSync(s,t,{spaces:` `}),await A(s))}}if(!await r.pathExists(d))return 0;if((await r.readdir(d)).length===0)return e.write(`Source directory "${d}" is empty.\n`),0;e.write(`Adding initial configuration files from:\n"${d}" → "${f}"\n`),await r.copy(d,f,{async filter(a,s){let c=i.statSync(a).isFile(),l=i.existsSync(s);if(c){if(p&&t===`package`&&a.includes(n))return l?(e.write(`Deleting: \n"${a}" → "${s}" (Because --location is set to "package")\n`),r.removeSync(s)):e.write(`Skipping: \n"${a}" → "${s}" (Because --location is set to "package")\n`),!1;if(l&&(s.includes(`.vscode/`)||s.includes(`package.json`))&&o.extname(s)===`.json`){e.write(`Merging: \n"${a}" → "${s}"\n`);let t=r.readJSONSync(a),n=w(r.readJSONSync(s),t);return r.writeJSONSync(s,n,{spaces:` `}),await A(s),!1}return l?(e.write(`Overwriting: \n"${a}" → "${s}"\n`),await A(s),!0):(e.write(`Copying: \n"${a}" → "${s}"\n`),await A(s),!0)}return!0},overwrite:!0})}catch(e){return console.error(String(e)),1}return 0}async function Te(e){let{commands:{fix:t,init:n,lint:r,printConfig:i},description:a,logColor:o,logPrefix:s,name:c,showSummary:l,verbose:u}=e,d=j(s,o);d.pipe(process.stdout);let f=p(m(process.argv)).scriptName(c).usage(`$0 <command>`,a);n!==void 0&&f.command({builder(e){return n.locationOptionFlag?e.option(`location`,{choices:[`file`,`package`],default:`file`,describe:`TK`,type:`string`}):e},command:`init`,describe:n.description??`Initialize by copying starter config files to your project root${n.locationOptionFlag?` or to your package.json file.`:`.`}`,async handler(e){let t=n.locationOptionFlag?e.location:void 0,r=await N(d,[],t===void 0?[]:[`--location`,t],[{async execute(e,t,r){return we(e,r.at(1),n.configFile,n.configPackageJson)},name:`copyAndMergeInitFiles`},...n.commands??[]]);process.exit(r)}}),r!==void 0&&f.command({builder(e){return r.positionalArgumentMode===`none`?e:e.positional(`files`,{array:!0,...r.positionalArgumentDefault===void 0?{}:{default:r.positionalArgumentDefault},describe:`Files or glob pattern to lint.`,type:`string`})},command:r.positionalArgumentMode===`none`?`lint`:r.positionalArgumentMode===`optional`?`lint [files..]`:`lint <files..>`,describe:r.description,async handler(e){let t=await N(d,e.files??[],[],r.commands,u,l);process.exit(t)}}),t!==void 0&&f.command({builder(e){return t.positionalArgumentMode===`none`?e:e.positional(`files`,{array:!0,...t.positionalArgumentDefault===void 0?{}:{default:t.positionalArgumentDefault},describe:`Files or glob pattern to fix.`,type:`string`})},command:t.positionalArgumentMode===`none`?`fix`:t.positionalArgumentMode===`optional`?`fix [files..]`:`fix <files..>`,describe:t.description,async handler(e){let n=await N(d,e.files??[],[],t.commands);process.exit(n)}}),i!==void 0&&f.command({builder(e){return i.positionalArgumentMode===`none`?e:e.positional(`file`,{...i.positionalArgumentDefault===void 0?{}:{default:i.positionalArgumentDefault},describe:`File or glob pattern to TK.`,type:`string`})},command:i.positionalArgumentMode===`none`?`print-config`:i.positionalArgumentMode===`optional`?`print-config [file]`:`print-config <file>`,describe:i.description,async handler(e){let t=e.file??void 0,n=await N(d,t===void 0?[]:[t],[],i.commands,u,l);process.exit(n)}}),f.alias(`h`,`help`),f.version(fe),f.alias(`v`,`version`),f.help(),f.wrap(process.stdout.isTTY?Math.min(120,f.terminalWidth()):0),await f.parseAsync()}function P(e){return{async execute(t){let n=await F(e);if(n===void 0)return 1;let{config:r,filepath:i,isEmpty:a}=n;if(t.write(`Found ${e} configuration at "${i}"\n`),a)return t.write(`Configuration is empty.
|
|
7
|
+
`),0;let o=C(r).split(`
|
|
8
|
+
`);for(let e of o)t.write(`${e}\n`);return 0},name:`Cosmiconfig ${e}`}}async function F(n){let r=e(n,{loaders:{".ts":t()},searchStrategy:`project`});try{let e=await r.search();if(e===null){console.error(`No ${n} configuration found.`);return}return e}catch(e){console.error(`Error while searching for ${n} configuration:`,e);return}}const I={fileRun:`Matches files below the current working directory by default.`,monorepoRun:`In a monorepo, it will also run in all packages below the current working directory.`,monorepoSearch:`Searches up to the root of a monorepo if necessary.`,multiArgumentCaveat:`Will use file arguments / globs where possible if provided, but some of the invoked tools only operate at the package-scope.`,multiOptionCaveat:`Will use option flags where possible if provided, but some of the invoked tools will ignore them.`,optionalFileRun:`Package-scoped by default, file-scoped if a file argument is provided.`,packageRun:`Package-scoped.`,packageSearch:`Package-scoped.`};async function Ee(e=[`.`]){let t=await y().searchForConfigFile(void 0);if(t===void 0)throw Error(`No CSpell configuration found.`);let{settings:n,url:r}=t;if(n.words===void 0||n.words.length===0)return[];let i=[...n.words];return n.words=void 0,await ae(e,{config:{settings:n,url:r},progress:!1,unique:!0,wordsOnly:!0},{issue({text:e,uri:t}){i=i.filter(n=>n.toLowerCase()!==e.toLowerCase().replace(/['\u2019\u2018]s$/,``)||t===r.href)}}),i}async function De(){let e=await y().searchForConfigFile(void 0);if(e===void 0)throw Error(`No CSpell configuration found.`);let t=await b(e);if(t.ignorePaths===void 0)return``;let n=[];for(let e of t.ignorePaths)n.push(typeof e==`string`?e:e.glob);return n.join(`,`)}async function L(e,t){let n=await Ee(t);if(n.length>0){let t=j(`[Unused Words]`,`cyanBright`);t.pipe(e);for(let e of n)t.write(`${e}\n`);return 1}return 0}async function Oe(){let e=import.meta.resolve(`@kitschpatrol/cspell-config`),t=await u({cwd:o.dirname(l(e))});if(t===void 0)throw Error(`Could not find Case Police dictionary parent package.`);let n=o.join(o.dirname(t),`dictionaries`,`case-police.json`);try{await re(n,a.F_OK)}catch{throw Error(`Case Police dictionary file "${n}" does not exist.`)}return n}async function ke(e,t){let n=`[Case Police]`,r=ve(e=>{let t=ie(e);return!t.startsWith(n)||!t.includes(`→`)});return r.pipe(e),N(r,t,[],[{logColor:`cyanBright`,logPrefix:n,name:`case-police`,optionFlags:[`--dict`,await Oe(),`--ignore`,await De()],receivePositionalArguments:!0}])}async function Ae(e){let t=await y().searchForConfigFile(void 0);if(t===void 0)throw Error(`No CSpell configuration found.`);e.write(`Found cspell readme configuration at "${l(t.url)}"\n`);let n=C(await b(t)).split(`
|
|
9
|
+
`);for(let t of n)e.write(`${t}\n`);return 0}const je={commands:{init:{configFile:`cspell.config.ts`,configPackageJson:{cspell:{import:`@kitschpatrol/cspell-config`}},locationOptionFlag:!0},lint:{commands:[{name:`cspell`,optionFlags:[`--quiet`],receivePositionalArguments:!0},{execute:L,name:L.name},{execute:ke,name:ke.name}],description:`Check for spelling mistakes. ${I.fileRun}`,positionalArgumentDefault:`**/*`,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:Ae,name:Ae.name}],description:`Print the resolved CSpell configuration. ${I.packageSearch} ${I.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's CSpell shared configuration tools. (Automated fixes are handled by ESLint.)`,logColor:`cyan`,logPrefix:`[CSpell]`,name:`ksc-cspell`,order:6};async function R(e,t){let n;if(t.length>0){let r=o.join(process.cwd(),t[0]);e.write(`Showing configuration for file: ${r}\n`),n={name:`eslint`,optionFlags:[`--print-config`],receivePositionalArguments:!0}}else n=P(`eslint`);return N(e,t,[],[n])}const Me={commands:{fix:{commands:[{name:`eslint`,optionFlags:[`--fix`],receivePositionalArguments:!0}],description:`Fix your project with ESLint. ${I.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},init:{locationOptionFlag:!1},lint:{commands:[{name:`eslint`,optionFlags:[`--max-warnings`,`0`],receivePositionalArguments:!0}],description:`Lint your project with ESLint. ${I.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:R,name:R.name}],description:`Print the effective ESLint configuration. ${I.optionalFileRun} Use \`@eslint/config-inspector\` for a more detailed view.`,positionalArgumentMode:`optional`}},description:`Kitschpatrol's ESLint shared configuration tools.`,logColor:`magenta`,logPrefix:`[ESLint]`,name:`ksc-eslint`,order:4},Ne={entry:[`{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`src/{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`src/{bin,lib,cli}/{index,cli,main}.{js,mjs,cjs,jsx,ts,tsx,mts,cts}!`,`scripts/**/*.{js,mjs,cjs,ts,mts,cts}`,`.remarkrc.{js,mjs,cjs,ts,mts,cts}`,`cspell.config.{js,mjs,cjs,ts,mts,cts}`,`eslint.config.{js,mjs,cjs,ts,mts,cts}`,`mdat.config.{js,mjs,cjs,ts,mts,cts}`,`prettier.config.{js,mjs,cjs,ts,mts,cts}`,`stylelint.config.{js,mjs,cjs,ts,mts,cts}`],ignoreBinaries:[`ksc-repo`,`ksc-mdat`,`ksc-typescript`,`ksc-eslint`,`ksc-stylelint`,`ksc-cspell`,`ksc-knip`,`ksc-remark`,`ksc-prettier`,`op`,`gh`],ignoreDependencies:[`@kitschpatrol/cspell-config`,`@kitschpatrol/dict-en-wiktionary`,`@kitschpatrol/eslint-config`,`@kitschpatrol/knip-config`,`@kitschpatrol/mdat-config`,`@kitschpatrol/prettier-config`,`@kitschpatrol/remark-config`,`@kitschpatrol/repo-config`,`@kitschpatrol/stylelint-config`,`@kitschpatrol/typescript-config`,`@prettier/plugin-php`,`@prettier/plugin-ruby`,`@prettier/plugin-xml`,`prettier-plugin-packagejson`,`prettier-plugin-sh`,`prettier-plugin-tailwindcss`,`prettier-plugin-toml`]};function Pe(){if(ge()){let e=E(),t=D();if(e!==t)return[`--workspace`,o.relative(t,e)]}return[]}function Fe(){return{knip:Ne}}const Ie={commands:{init:{configFile:`knip.config.ts`,configPackageJson:Fe(),locationOptionFlag:!0},lint:{commands:[{cwdOverride:`workspace-root`,name:`knip`,optionFlags:[`--no-progress`,`--no-config-hints`,...Pe()]}],description:`Check for unused code and dependencies. ${I.packageRun} ${I.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[P(`knip`)],description:`Print the effective Knip configuration. ${I.packageSearch} ${I.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Knip shared configuration tools.`,logColor:`cyan`,logPrefix:`[Knip]`,name:`ksc-knip`,order:7};async function Le(){return(await F(`mdat`))?.filepath}async function z(e){let t=`mdat`,n=await F(t);n!==void 0&&e.write(`Found ${t} readme configuration at "${n.filepath}"\n`);let r=C(await se({additionalConfig:await oe()})).split(`
|
|
10
|
+
`);for(let t of r)e.write(`${t}\n`);return 0}async function B(e){let t=T(),n=await Le(),r=[];for(let i of t)r.push({cwdOverride:i,name:`mdat`,optionFlags:n?[`--config`,n]:[],subcommands:[`readme`,e]});return r}const Re={commands:{fix:{commands:await B(`expand`),description:`Expand all Mdat content placeholders in your readme.md file(s). ${I.packageRun} ${I.monorepoRun}`,positionalArgumentMode:`none`},init:{configFile:`mdat.config.ts`,configPackageJson:{mdat:{$import:`node_modules/@kitschpatrol/mdat-config/dist/index.js`}},locationOptionFlag:!0},lint:{commands:await B(`check`),description:`Validate that all Mdat content placeholders in your readme.md file(s) have been expanded. ${I.packageRun} ${I.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{execute:z,name:z.name}],description:`Print the effective Mdat configuration. ${I.packageSearch}. ${I.monorepoSearch}. Includes configuration provided by the \`mdat readme\` command.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Mdat shared configuration tools.`,logColor:`green`,logPrefix:`[Mdat Config]`,name:`ksc-mdat`,order:2},V=[`--log-level=warn`,`--plugin=@prettier/plugin-php`,`--plugin=@prettier/plugin-ruby`,`--plugin=@prettier/plugin-xml`,`--plugin=prettier-plugin-astro`,`--plugin=prettier-plugin-packagejson`,`--plugin=prettier-plugin-sh`,`--plugin=prettier-plugin-svelte`,`--plugin=prettier-plugin-tailwindcss`,`--plugin=prettier-plugin-toml`,`--ignore-path=${O(`.gitignore`)??`.gitignore`}`,`--ignore-path=${O(`.prettierignore`)??`.prettierignore`}`],ze={commands:{fix:{commands:[{name:`prettier`,optionFlags:[...V,`--write`],receivePositionalArguments:!0}],description:`Format files according to your Prettier configuration. ${I.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},init:{configFile:`prettier.config.ts`,configPackageJson:{prettier:`@kitschpatrol/prettier-config`},locationOptionFlag:!0},lint:{commands:[{name:`prettier`,optionFlags:[...V,`--check`],receivePositionalArguments:!0}],description:`Check that files are formatted according to your Prettier configuration. ${I.fileRun}`,positionalArgumentDefault:`.`,positionalArgumentMode:`optional`},printConfig:{commands:[P(`prettier`)],description:`Print the effective Prettier configuration. ${I.packageSearch}. ${I.monorepoSearch}.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Prettier shared configuration tools.`,logColor:`blue`,logPrefix:`[Prettier]`,name:`ksc-prettier`,order:9},Be={commands:{init:{configFile:`.remarkrc.js`,configPackageJson:{remarkConfig:{plugins:[`@kitschpatrol/remark-config`]}},locationOptionFlag:!0},printConfig:{commands:[P(`remark`)],description:`Print the effective Remark configuration. ${I.packageSearch} ${I.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's Remark and Remark Lint shared configuration tools. (Actual linting and fixing is managed through @kitschpatrol/eslint-config.)`,logColor:`blue`,logPrefix:`[remarklint]`,name:`ksc-remark`,order:8};function Ve(e,t){let n=/(\d{4})\s*-\s*(\d{4})/,r=n.exec(e);if(r){let[,i,a]=r;if(Number.parseInt(a,10)!==t){let r=`${i}-${t}`;return e.replace(n,r)}return e}let i=/(\d{4})/,a=i.exec(e);if(a){let[,n]=a;if(Number.parseInt(n,10)!==t){let r=`${n}-${t}`;return e.replace(i,r)}return e}return e}async function H(e,t=!1){let n=new Date().getFullYear(),r=[],i=await ce([`**/license.txt`,`**/license`,`!node_modules/**`],{caseSensitiveMatch:!1,cwd:E(),followSymbolicLinks:!1,gitignore:!0});for(let e of i)r.push(e);let a=[];for(let e of r)try{let r=await v.readFile(e,`utf8`),i=Ve(r,n);i!==r&&(a.push(e),t&&await v.writeFile(e,i,`utf8`))}catch(t){console.error(`Failed to process ${e}:`,t)}if(a.length>0){e.write(`${t?`Fixed`:`Found`} ${a.length} license ${M(`file`,a.length)} with outdated copyright year:\n`);for(let t of a)e.write(` - ${t}\n`);return t?0:1}return 0}async function U(e){return H(e,!1)}async function W(e){return H(e,!0)}const G=`pnpm-lock.yaml`;function He(e){let t=D(),n=o.resolve(e);for(;;){if(r.existsSync(o.join(n,G)))return n;if(n===t)break;let e=o.dirname(n);if(e===n)break;n=e}}function Ue(e,t,n){let r=`${e}@${t}`;if(r in n)return r;if(t in n)return t}async function K(e){let t=He(e);if(!t)throw Error(`${G} not found at or above "${e}".`);let n=o.join(t,G),r=await ue(t,{ignoreIncompatible:!1});if(!r?.importers)throw Error(`Lockfile at "${n}" is unreadable or missing importers.`);let i=r.packages??{},a,s,c={},l={};function u(e,t){let n,r=new Set;function a(e,t){if(t.startsWith(`link:`))return;let o=Ue(e,t,i);if(!o||r.has(o))return;r.add(o);let s=i[o],c=s?.engines?.node;if(c){let e=le(c)?.version;e&&(!n||S(e,n))&&(n=e)}if(s?.dependencies)for(let[e,t]of Object.entries(s.dependencies))typeof t==`string`&&a(e,t)}return a(e,t),n}function d(e,t){for(let[n,r]of Object.entries(e)){let e=u(n,typeof r==`string`?r:r.version);if(e){let r=t?l:c;r[e]??=new Set,r[e].add(n);let i=t?s:a;(!i||S(e,i))&&(t?s=e:a=e)}}}let f=o.relative(t,e)||`.`,p=r.importers[f];p&&(p.dependencies&&d(p.dependencies,!1),p.devDependencies&&d(p.devDependencies,!0));let m=a&&s?S(a,s)?`>=${a}`:`>=${s}`:a?`>=${a}`:s?`>=${s}`:void 0;return{dependencies:a?{topLevelCauses:[...c[a]],version:`>=${a}`}:void 0,devDependencies:s?{topLevelCauses:[...l[s]],version:`>=${s}`}:void 0,lockfile:n,version:m}}function We(e){let t=e.devEngines;if(t?.runtime)return(Array.isArray(t.runtime)?t.runtime:[t.runtime]).find(e=>e.name===`node`)?.version}function q(e,t){let n=e.devEngines??{};if(n.runtime)if(Array.isArray(n.runtime)){let e=n.runtime.findIndex(e=>e.name===`node`);e===-1?n.runtime.push({name:`node`,version:t}):n.runtime[e].version=t}else n.runtime.name===`node`?n.runtime.version=t:n.runtime=[n.runtime,{name:`node`,version:t}];else n.runtime={name:`node`,version:t};e.devEngines=n}function Ge(e){let t=e.devEngines;t?.runtime&&(Array.isArray(t.runtime)?(t.runtime=t.runtime.filter(e=>e.name!==`node`),t.runtime.length===0?delete t.runtime:t.runtime.length===1&&(t.runtime=t.runtime[0])):t.runtime.name===`node`&&delete t.runtime,Object.keys(t).length===0&&delete e.devEngines)}function J(e){return e.length===0?``:` (from ${e.join(`, `)})`}async function Ke(e,t,n){let i=o.join(n,`package.json`);if(!r.existsSync(i))return 0;let a=r.readJsonSync(i),s=a.engines?.node,c=We(a),l=await K(n),u=l.dependencies?.version,d=l.version,f=l.dependencies?.topLevelCauses??[],p=l.devDependencies?.topLevelCauses??[],m=u??d,h=u?f:p,g=[];if(m!==void 0)if(s===void 0){if(g.push(`Missing engines.node — suggest setting to "${m}"${J(h)}`),t){let e=a.engines??{};e.node=m,a.engines=e}}else{let e=x.minVersion(s),n=x.minVersion(m);e&&n&&x.lt(e,n)&&(g.push(`engines.node is "${s}" but dependencies require at least "${m}"${J(h)}`),t&&(a.engines.node=m))}if(m!==void 0&&d!==void 0)if(m!==d)if(c===void 0)g.push(`devDependencies require a different Node.js minimum (${d}) than production (${m}) — suggest adding devEngines.runtime for node with version "${d}"${J(p)}`),t&&q(a,d);else{let e=x.minVersion(c),n=x.minVersion(d);e&&n&&x.lt(e,n)&&(g.push(`devEngines.runtime.version for node is "${c}" but all dependencies require at least "${d}"${J(p)}`),t&&q(a,d))}else c!==void 0&&(g.push(`devEngines.runtime.version for node is redundant (same minimum as engines.node) — suggest removing`),t&&Ge(a));if(g.length>0){e.write(`${t?`Fixed`:`Found`} ${g.length} Node.js version ${M(`issue`,g.length)} in ${i}:\n`);for(let t of g)e.write(` - ${t}\n`);return t?(r.writeJsonSync(i,a,{spaces:` `}),await A(i),0):1}return 0}async function Y(e,t){let n=T(),r=0;for(let i of n)await Ke(e,t,i)!==0&&(r=1);return r}async function X(e){let t=C(await K(E())).split(`
|
|
11
|
+
`);for(let n of t)e.write(`${n}\n`);return 0}async function Z(e){return Y(e,!1)}async function qe(e){return Y(e,!0)}const Je={commands:{fix:{commands:[{execute:W,name:U.name},{execute:qe,name:qe.name}],description:`Fix common issues like outdated copyright years in license files. ${I.packageRun} ${I.monorepoRun}`,positionalArgumentMode:`none`},init:{locationOptionFlag:!1},lint:{commands:[{execute:U,name:W.name},{execute:Z,name:Z.name}],description:`Check the repo for common issues. ${I.packageRun} ${I.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{execute:X,name:X.name}],description:`Print minimum Node.js version constraints from the pnpm lockfile.`,positionalArgumentMode:`none`}},description:`Kitschpatrol's repository-related shared configuration tools.`,logColor:`gray`,logPrefix:`[Repo Config]`,name:`ksc-repo`,order:1},Ye=[`--ignore-path`,O(`.gitignore`)??`.gitignore`,`--allow-empty-input`],Xe=`**/*.{${[`css`,`scss`,`sass`,`svelte`,`html`,`astro`,`tsx`,`jsx`,`php`,`vue`].join(`,`)}}`;async function Ze(e,t){let n=`stylelint`,r=await F(n);if(r===void 0)return 1;let{filepath:i,isEmpty:a}=r;if(a)return e.write(`Configuration is empty.
|
|
12
|
+
`),0;e.write(`Found ${n} configuration at "${i}"\n`);let s;t.length>0?(s=o.join(process.cwd(),t[0]),e.write(`Showing config for file at "${s}"\n`)):s=k(`package-dir`);let c=C(await de.resolveConfig(s)).split(`
|
|
13
|
+
`);for(let t of c)e.write(`${t}\n`);return 0}const Qe={commands:{fix:{commands:[{name:`stylelint`,optionFlags:[...Ye,`--fix`],receivePositionalArguments:!0}],description:`Fix your project with Stylelint. ${I.fileRun}`,positionalArgumentDefault:Xe,positionalArgumentMode:`optional`},init:{configFile:`stylelint.config.js`,configPackageJson:{stylelint:{extends:`@kitschpatrol/stylelint-config`}},locationOptionFlag:!0},lint:{commands:[{name:`stylelint`,optionFlags:Ye,receivePositionalArguments:!0}],description:`Lint your project with Stylelint. ${I.fileRun}`,positionalArgumentDefault:Xe,positionalArgumentMode:`optional`},printConfig:{commands:[{execute:Ze,name:Ze.name}],description:`Print the effective Stylelint configuration. ${I.optionalFileRun}.`,positionalArgumentMode:`optional`}},description:`Kitschpatrol's Stylelint shared configuration tools.`,logColor:`greenBright`,logPrefix:`[Stylelint]`,name:`ksc-stylelint`,order:5};async function $e(){let e=E(),t=[`svelte.config.js`,`svelte.config.mjs`,`svelte.config.cjs`].map(async t=>r.exists(o.join(e,t)));return(await Promise.all(t)).some(Boolean)}async function et(e){return e.write("Skipping `tsc` since this is a Svelte project. Consider running `svelte-check` instead.\n"),0}async function tt(){return await $e()?[{execute:et,name:et.name}]:[{cwdOverride:`package-dir`,name:`tsc`,optionFlags:[`--noEmit`]}]}const Q=[Me,je,Ie,Re,ze,Be,Je,Qe,{commands:{init:{locationOptionFlag:!1},lint:{commands:await tt(),description:`Run type checking on your project. ${I.packageRun} ${I.monorepoRun}`,positionalArgumentMode:`none`},printConfig:{commands:[{name:`tsc`,optionFlags:[`--showConfig`],prettyJsonOutput:!0}],description:`Print the TypeScript configuration for the project. ${I.packageSearch} ${I.monorepoSearch}`,positionalArgumentMode:`none`}},description:`Kitschpatrol's TypeScript shared configuration tools.`,logColor:`blueBright`,logPrefix:`[TypeScript Config]`,name:`ksc-typescript`,order:3}];function $(e,t){t.sort((e,t)=>e.order-t.order);let n=[];for(let r of t)Object.keys(r.commands).includes(e)&&n.push({name:r.name,...e===`init`?{receiveOptionFlags:r.commands[e]?.locationOptionFlag}:{receivePositionalArguments:r.commands[e]?.positionalArgumentMode!==`none`},subcommands:[be(e)]});return n}await Te({commands:{fix:{commands:$(`fix`,Q),description:`Fix your project with multiple tools in one go. ${I.multiArgumentCaveat}`,positionalArgumentMode:`optional`},init:{commands:$(`init`,Q),description:`Initialize configuration files for the entire suite of @kitschpatrol/shared-config tools. ${I.multiOptionCaveat}`,locationOptionFlag:!0},lint:{commands:$(`lint`,Q),description:`Lint your project with multiple tools in one go. ${I.multiArgumentCaveat}`,positionalArgumentMode:`optional`},printConfig:{commands:$(`printConfig`,Q),description:`Print aggregated tool configuration data. ${I.multiArgumentCaveat}`,positionalArgumentMode:`optional`}},description:`Run aggregated @kitschpatrol/shared-config commands.`,logColor:`yellow`,logPrefix:`🔬`,name:`ksc`,order:0,showSummary:!0,verbose:!0});export{};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/shared-config",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.0.2",
|
|
4
4
|
"description": "A collection of shared configurations, linters, and formatting tools for TypeScript projects. All managed as a single dependency, and invoked via a single CLI command.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -58,15 +58,15 @@
|
|
|
58
58
|
"semver": "^7.7.4",
|
|
59
59
|
"stylelint": "^17.4.0",
|
|
60
60
|
"yargs": "^18.0.0",
|
|
61
|
-
"@kitschpatrol/cspell-config": "6.0.
|
|
62
|
-
"@kitschpatrol/eslint-config": "6.0.
|
|
63
|
-
"@kitschpatrol/
|
|
64
|
-
"@kitschpatrol/
|
|
65
|
-
"@kitschpatrol/
|
|
66
|
-
"@kitschpatrol/
|
|
67
|
-
"@kitschpatrol/
|
|
68
|
-
"@kitschpatrol/stylelint-config": "6.0.
|
|
69
|
-
"@kitschpatrol/typescript-config": "6.0.
|
|
61
|
+
"@kitschpatrol/cspell-config": "6.0.2",
|
|
62
|
+
"@kitschpatrol/eslint-config": "6.0.2",
|
|
63
|
+
"@kitschpatrol/knip-config": "6.0.2",
|
|
64
|
+
"@kitschpatrol/repo-config": "6.0.2",
|
|
65
|
+
"@kitschpatrol/remark-config": "6.0.2",
|
|
66
|
+
"@kitschpatrol/prettier-config": "6.0.2",
|
|
67
|
+
"@kitschpatrol/mdat-config": "6.0.2",
|
|
68
|
+
"@kitschpatrol/stylelint-config": "6.0.2",
|
|
69
|
+
"@kitschpatrol/typescript-config": "6.0.2"
|
|
70
70
|
},
|
|
71
71
|
"engines": {
|
|
72
72
|
"node": ">=20.19.0"
|