@kitschpatrol/shared-config 4.4.2 → 4.5.0

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.
Files changed (2) hide show
  1. package/package.json +21 -9
  2. package/readme.md +19 -15
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@kitschpatrol/shared-config",
3
- "version": "4.4.2",
3
+ "version": "4.5.0",
4
4
  "type": "module",
5
- "description": "Linting and formatting for web projects.",
5
+ "description": "A collection of shared configurations for various linters and formatting tools. All managed as a single dependency, and invoked via a single command.",
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "git@github.com:kitschpatrol/shared-config.git",
@@ -28,18 +28,30 @@
28
28
  "files": [
29
29
  "bin/*"
30
30
  ],
31
+ "keywords": [
32
+ "shared-config",
33
+ "eslint-config",
34
+ "stylelint-config",
35
+ "prettier-config",
36
+ "remark-config",
37
+ "remark-lint",
38
+ "github-actions",
39
+ "cspell",
40
+ "mdat",
41
+ "cli"
42
+ ],
31
43
  "dependencies": {
32
44
  "@pinojs/json-colorizer": "^4.0.0",
33
45
  "cosmiconfig": "^9.0.0",
34
46
  "execa": "^8.0.1",
35
47
  "fs-extra": "^11.2.0",
36
- "@kitschpatrol/cspell-config": "4.4.2",
37
- "@kitschpatrol/eslint-config": "4.4.2",
38
- "@kitschpatrol/mdat-config": "4.4.2",
39
- "@kitschpatrol/remark-config": "4.4.2",
40
- "@kitschpatrol/prettier-config": "4.4.2",
41
- "@kitschpatrol/repo-config": "4.4.2",
42
- "@kitschpatrol/stylelint-config": "4.4.2"
48
+ "@kitschpatrol/cspell-config": "4.5.0",
49
+ "@kitschpatrol/mdat-config": "4.5.0",
50
+ "@kitschpatrol/eslint-config": "4.5.0",
51
+ "@kitschpatrol/prettier-config": "4.5.0",
52
+ "@kitschpatrol/remark-config": "4.5.0",
53
+ "@kitschpatrol/stylelint-config": "4.5.0",
54
+ "@kitschpatrol/repo-config": "4.5.0"
43
55
  },
44
56
  "devDependencies": {
45
57
  "camelcase": "^8.0.0",
package/readme.md CHANGED
@@ -7,7 +7,7 @@
7
7
  [![NPM Package @kitschpatrol/shared-config](https://img.shields.io/npm/v/@kitschpatrol/shared-config.svg)](https://npmjs.com/package/@kitschpatrol/shared-config)
8
8
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
9
9
 
10
- **Linting and formatting for web projects.**
10
+ **A collection of shared configurations for various linters and formatting tools. All managed as a single dependency, and invoked via a single command.**
11
11
 
12
12
  <!-- /header -->
13
13
 
@@ -29,6 +29,8 @@
29
29
 
30
30
  This project attempts to consolidate most of the configuration and tooling shared by my open-source and internal TypeScript / Node based projects into a single dependency.
31
31
 
32
+ ### Tools
33
+
32
34
  It takes care of dependencies and configurations for the following tools:
33
35
 
34
36
  - [CSpell](https://cspell.org)
@@ -40,13 +42,25 @@ It takes care of dependencies and configurations for the following tools:
40
42
  - [VS Code](https://code.visualstudio.com) (extension recommendations and extension settings)
41
43
  - Minimal repo boilerplate (`.npmrc`, `.gitignore`, etc.)
42
44
 
43
- All of the above may be added to a project as a single dependency. All may be run simultaneously over a repo with a single command with options to either check or (where possible) fix problems, with output aggregated into a single report.
45
+ ### Packages
46
+
47
+ This readme is for the [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) package, which depends on a number of tool-specific packages included in the [`kitschpatrol/shared-config`](https://github.com/kitschpatrol/shared-config) monorepo on GitHub, each of which is documented in its respective readme, linked below:
48
+
49
+ - [`@kitschpatrol/cspell-config`](/packages/cspell-config/readme.md)
50
+ - [`@kitschpatrol/eslint-config`](/packages/eslint-config/readme.md)
51
+ - [`@kitschpatrol/mdat-config`](/packages/mdat-config/readme.md)
52
+ - [`@kitschpatrol/prettier-config`](/packages/prettier-config/readme.md)
53
+ - [`@kitschpatrol/remark-config`](/packages/remark-config/readme.md)
54
+ - [`@kitschpatrol/repo-config`](/packages/repo-config/readme.md)
55
+ - [`@kitschpatrol/stylelint-config`](/packages/stylelint-config/readme.md)
56
+
57
+ Any of these may be installed and run on their own via CLI if desired. However, in general, the idea is to use `@kitschpatrol/shared-config` to easily run them all simultaneously over a repo with a single command with options to either check or (where possible) fix problems, with output aggregated into a single report.
44
58
 
45
59
  ## Getting started
46
60
 
47
61
  ### Dependencies
48
62
 
49
- Node 18+ and pnpm are required. It probably works with NPM and yarn, but I haven't tested it.
63
+ Node 18+ and [pnpm](https://pnpm.io) are required. It probably works with NPM and yarn, but I haven't tested it.
50
64
 
51
65
  ### Installation
52
66
 
@@ -122,7 +136,7 @@ pnpm run format
122
136
 
123
137
  #### Command: `shared-config`
124
138
 
125
- Linting and formatting for web projects.
139
+ A collection of shared configurations for various linters and formatting tools. All managed as a single dependency, and invoked via a single command.
126
140
 
127
141
  Usage:
128
142
 
@@ -141,17 +155,7 @@ shared-config [<file|glob> ...]
141
155
 
142
156
  <!-- /cli-help -->
143
157
 
144
- The `@kitschpatrol/shared-config` package aggregates integration and invocation of the other tool-specific packages in this monorepo, each of which is documented in its respective readme, linked below:
145
-
146
- - [`@kitschpatrol/cspell-config`](/packages/cspell-config/readme.md)
147
- - [`@kitschpatrol/eslint-config`](/packages/eslint-config/readme.md)
148
- - [`@kitschpatrol/mdat-config`](/packages/mdat-config/readme.md)
149
- - [`@kitschpatrol/prettier-config`](/packages/prettier-config/readme.md)
150
- - [`@kitschpatrol/remark-config`](/packages/remark-config/readme.md)
151
- - [`@kitschpatrol/repo-config`](/packages/repo-config/readme.md)
152
- - [`@kitschpatrol/stylelint-config`](/packages/stylelint-config/readme.md)
153
-
154
- Any of these may be installed and run on their own via CLI if desired. However, in general, the idea is to use `@kitschpatrol/shared-config`.
158
+ Recall that the `@kitschpatrol/shared-config` package aggregates integration and invocation of the other tool-specific packages in this monorepo. Running a cli command on `shared-config` effectively runs the same command against all the tool-specific packages.
155
159
 
156
160
  ## Implementation notes
157
161