@ntnyq/eslint-config 3.2.2 → 3.3.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.
package/README.md CHANGED
@@ -108,7 +108,7 @@ Check for detail in:
108
108
  ### Config interface
109
109
 
110
110
  ```ts
111
- export interface ConfigOptions {
111
+ export interface ConfigOptions extends ConfigOptionsInternal {
112
112
  ignores?: ConfigIgnoresOptions
113
113
 
114
114
  sort?: boolean | ConfigSortOptions
@@ -131,21 +131,6 @@ export interface ConfigOptions {
131
131
 
132
132
  perfectionist?: boolean | ConfigPerfectionistOptions
133
133
 
134
- /**
135
- * @internal
136
- */
137
- unusedImports?: boolean | ConfigUnusedImportsOptions
138
-
139
- /**
140
- * @internal
141
- */
142
- antfu?: boolean | ConfigAntfuOptions
143
-
144
- /**
145
- * @internal
146
- */
147
- ntnyq?: boolean | ConfigNtnyqOptions
148
-
149
134
  comments?: boolean | ConfigCommentsOptions
150
135
 
151
136
  jsdoc?: boolean | ConfigJsdocOptions
@@ -165,9 +150,30 @@ export interface ConfigOptions {
165
150
  vue?: boolean | ConfigVueOptions
166
151
 
167
152
  test?: boolean | ConfigTestOptions
153
+
154
+ antfu?: boolean | ConfigAntfuOptions
155
+
156
+ githubAction?: boolean | ConfigGitHubActionOptions
168
157
  }
169
158
  ```
170
159
 
160
+ ## Versioning policy
161
+
162
+ This project follows [Semantic Versioning](https://semver.org/) for releases.
163
+
164
+ ### Changes considered as Breaking Changes
165
+
166
+ - Node.js version requirement changes
167
+ - Huge refactors that might break the config
168
+ - Plugins made major changes that might break the config
169
+ - Changes that might affect most of the codebases
170
+
171
+ ### Changes considered as Non-Breaking Changes
172
+
173
+ - Enable/disable rules and plugins (that might become stricter)
174
+ - Rules options changes
175
+ - Version bumps of dependencies
176
+
171
177
  ## Credits
172
178
 
173
179
  - [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)