mikey-pro 7.0.1 → 7.0.3

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 +55 -6
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -57,6 +57,7 @@ _A curated compilation of packages, plugins, style guides, custom configurations
57
57
  </tbody>
58
58
  </table>
59
59
  </div>
60
+
60
61
  ## Requirements
61
62
 
62
63
  Install extensions:
@@ -67,10 +68,6 @@ Install extensions:
67
68
  <a href="https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint">Stylelint</a>
68
69
 
69
70
  Additional support:
70
- <a href="https://marketplace.visualstudio.com/items?itemName=octref.vetur">Vetur</a>
71
- |
72
- <a href="https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode">Svelte</a>
73
- |
74
71
  <a href="https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck">ShellCheck</a>
75
72
 
76
73
  ## Usage
@@ -81,9 +78,9 @@ Additional support:
81
78
  npm i -D mikey-pro
82
79
  ```
83
80
 
84
- ### Configure
81
+ ### Configuration
85
82
 
86
- Add bundled configs to `package.json` and then reload
83
+ Add bundled configs to `package.json`
87
84
 
88
85
  ```json
89
86
  {
@@ -96,3 +93,55 @@ Add bundled configs to `package.json` and then reload
96
93
  }
97
94
  }
98
95
  ```
96
+
97
+ ### Frameworks
98
+
99
+ Each framework configuration extends the base `@mikey-pro/eslint-config`
100
+
101
+ #### React
102
+
103
+ ```shell
104
+ npm i -D mikey-pro @mikey-pro/eslint-config-react
105
+ ```
106
+
107
+ ```json
108
+ {
109
+ "eslintConfig": {
110
+ "extends": "@mikey-pro/eslint-config-react"
111
+ }
112
+ }
113
+ ```
114
+
115
+ #### Svelte
116
+
117
+ ```shell
118
+ npm i -D mikey-pro @mikey-pro/eslint-config-svelte
119
+ ```
120
+
121
+ ```json
122
+ {
123
+ "eslintConfig": {
124
+ "extends": "@mikey-pro/eslint-config-svelte"
125
+ }
126
+ }
127
+ ```
128
+
129
+ <a href="https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode">Svelte
130
+ Extension</a>
131
+
132
+ #### Vue
133
+
134
+ ```shell
135
+ npm i -D mikey-pro @mikey-pro/eslint-config-vue
136
+ ```
137
+
138
+ ```json
139
+ {
140
+ "eslintConfig": {
141
+ "extends": "@mikey-pro/eslint-config-vue"
142
+ }
143
+ }
144
+ ```
145
+
146
+ <a href="https://marketplace.visualstudio.com/items?itemName=octref.vetur">Vetur
147
+ Extension</a>
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "mikey-pro",
3
- "version": "7.0.1",
3
+ "version": "7.0.3",
4
4
  "description": "Mikey Pro Style Guide",
5
5
  "dependencies": {
6
- "@mikey-pro/eslint-config": "^7.0.1",
6
+ "@mikey-pro/eslint-config": "^7.0.3",
7
7
  "@mikey-pro/prettier-config": "^7.0.0",
8
8
  "@mikey-pro/stylelint-config": "^7.0.0",
9
9
  "eslint": "^8.56.0",