@dvukovic/style-guide 0.3.100 → 0.3.101

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/README.md +30 -12
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -67,7 +67,7 @@ Add these scripts to your `package.json`:
67
67
  "lint:eslint": "eslint . --cache --concurrency=auto",
68
68
  "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix && yarn lint:spell",
69
69
  "lint:prettier": "prettier --check --cache .",
70
- "lint:spell": "cspell --config ./.cspellrc.js --no-progress --no-summary --unique '**'",
70
+ "lint:spell": "cspell --no-progress --no-summary --unique '**'",
71
71
  "lint:stylelint": "stylelint ./**/*.css --cache",
72
72
  "test": "vitest run"
73
73
  }
@@ -112,7 +112,7 @@ export default customDefineConfig(
112
112
 
113
113
  ## Prettier Configuration
114
114
 
115
- ```js
115
+ ```js prettier.config.ts
116
116
  import type { Config } from "prettier"
117
117
 
118
118
  import core from "@dvukovic/style-guide/src/prettier/configs/core.js"
@@ -126,18 +126,36 @@ export default config
126
126
 
127
127
  ## Stylelint Configuration
128
128
 
129
- ```js
130
- import { stylelint } from "@dvukovic/style-guide/stylelint"
131
-
132
- export default stylelint
129
+ ```js stylelint.config.js
130
+ /** @type {import("stylelint").Config} */
131
+ module.exports = {
132
+ extends: "@dvukovic/style-guide/src/stylelint/configs/core",
133
+ allowEmptyInput: true,
134
+ }
133
135
  ```
134
136
 
135
- ## Package.json Configuration
136
-
137
- ```js
138
- import { packageJson } from "@dvukovic/style-guide/package-json"
139
-
140
- export default packageJson
137
+ ## Cspell Configuration
138
+
139
+ ```cspell.config.js
140
+ /** @type {import("cspell").FileSettings} */
141
+ module.exports = {
142
+ cache: {
143
+ cacheLocation: "./node_modules/.cache/cspell",
144
+ useCache: true,
145
+ },
146
+ caseSensitive: false,
147
+ ignorePaths: [],
148
+ dictionaries: ["shared"],
149
+ dictionaryDefinitions: [
150
+ {
151
+ name: "shared",
152
+ path: "./node_modules/@dvukovic/style-guide/src/cspell/base.txt",
153
+ },
154
+ ],
155
+ useGitignore: true,
156
+ ignoreWords: [
157
+ ],
158
+ }
141
159
  ```
142
160
 
143
161
  ## License
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dvukovic/style-guide",
3
- "version": "0.3.100",
3
+ "version": "0.3.101",
4
4
  "description": "My own style guide",
5
5
  "repository": {
6
6
  "type": "git",
@@ -23,7 +23,7 @@
23
23
  "lint:eslint": "eslint . --cache --concurrency=auto",
24
24
  "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix && yarn lint:spell",
25
25
  "lint:prettier": "prettier --check --cache .",
26
- "lint:spell": "cspell --config ./.cspellrc.js --no-progress --no-summary --unique '**'",
26
+ "lint:spell": "cspell --no-progress --no-summary --unique '**'",
27
27
  "lint:stylelint": "stylelint ./**/*.css --cache",
28
28
  "release": "release-it",
29
29
  "test": "vitest run"