Commitabcfc3b

authored

Merge pull request#584 from github/gracepark/filenames-default-update

Update filenames default since it is now in our repo

2 parents5bb75fb +2b0173c commitabcfc3bCopy full SHA for abcfc3b

File tree

+25

-9

lines changed

+25

-9

lines changed

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -56,9 +56,11 @@ export default [`
`56`	`56`	```
`57`	`57`
`58`	`58`	`>[!NOTE]`
`59`		->If you configured the`filenames/match-regex` rule, please note we have adapted the match regex rule into`eslint-plugin-github` as the original`eslint-filenames-plugin` is no longer maintained and needed an ESLint v9/flat config update. Please update the name to`github/filenames-match-regex` and keep the same configuration. Note, that the default rule is camelCase with one hump. If there are multiple humps like`camelCaseTest.js`, this default rule will error out. Here's an example for this rule with custom configuration:
	`59`	+>If you configured the`filenames/match-regex` rule, please note we have adapted the match regex rule into`eslint-plugin-github` as the original`eslint-filenames-plugin` is no longer maintained and needed a flat config support update.
	`60`	`+>`
	`61`	+>Please update the name to`github/filenames-match-regex`, and note, the default rule is kebab case or camelCase with one hump. For custom configuration, such as matching for camelCase regex, here's an example:
`60`	`62`	`>`
`61`		->`'github/filenames-match-regex': ['error', '^[a-z0-9-]+(.[a-z0-9-]+)?$']`
	`63`	+>`'github/filenames-match-regex': ['error', '^([a-z0-9]+)([A-Z][a-z0-9]+)*$'],`
`62`	`64`
`63`	`65`	`The available configs are:`
`64`	`66`

Lines changed: 17 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -4,26 +4,38 @@`
`4`	`4`
`5`	`5`	`##Rule Details`
`6`	`6`
`7`		`-Rule to ensure that filenames match a convention, with a default of camelCase forESLint v9+.`
	`7`	`+Rule to ensure that filenames match a convention, with a default ofkebab case orcamelCasewith one humpforflat config.`
`8`	`8`
`9`	`9`	`👎 Examples ofincorrect filename for this default rule:`
`10`	`10`
`11`		-`file-name.js`
	`11`	+-`fileNameRule.js`
`12`	`12`
`13`	`13`	`👍 Examples ofcorrect code for this rule:`
`14`	`14`
`15`		-`fileName.js`
	`15`	+-`fileName.js`
	`16`	+-`file-name.js`
`16`	`17`
`17`	`18`	`##Options`
`18`	`19`
`19`		`-regex - Regex to match the filename structure. Defaults to camelCase.`
	`20`	`+regex - Regex to match the filename structure. Defaults tokebab case orcamelCase with one hump.`
`20`	`21`
	`22`	`+Default:`
	`23`	`+`
	`24`	+```json
	`25`	`+{`
	`26`	`+"filenames-match-regex": [`
	`27`	`+"error"`
	`28`	`+ ]`
	`29`	`+}`
	`30`	+```
	`31`	`+`
	`32`	`+If you want to add custom regex such as matching all camelCase, add the regex as a string. For example, for camelCase it would look like:`
`21`	`33`
`22`	`34`	```json
`23`	`35`	`{`
`24`	`36`	`"filenames-match-regex": [`
`25`	`37`	`"error",`
`26`		`-"^[a-z0-9-]+(.[a-z0-9-]+)?$"`
	`38`	`+"^([a-z0-9]+)([A-Z][a-z0-9]+)*$"`
`27`	`39`	`]`
`28`	`40`	`}`
`29`	`41`	```

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ module.exports = {`
`32`	`32`	`'eslintComments/no-unused-disable':'error',`
`33`	`33`	`'eslintComments/no-unused-enable':'error',`
`34`	`34`	`'eslintComments/no-use':['error',{allow:['eslint','eslint-disable-next-line','eslint-env','globals']}],`
`35`		`-'github/filenames-match-regex':['error','^[a-z0-9-]+(.[a-z0-9-]+)?$'],`
	`35`	`+'github/filenames-match-regex':'error',`
`36`	`36`	`'func-style':['error','declaration',{allowArrowFunctions:true}],`
`37`	`37`	`'github/array-foreach':'error',`
`38`	`38`	`'github/no-implicit-buggy-globals':'error',`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,8 @@ module.exports = {`
`25`	`25`	`},`
`26`	`26`
`27`	`27`	`create(context){`
`28`		`-constdefaultRegexp=/^([a-z0-9]+)([A-Z][a-z0-9]+)*$/g`
	`28`	`+// GitHub's default is kebab case or one hump camel case`
	`29`	`+constdefaultRegexp=/^[a-z0-9-]+(.[a-z0-9-]+)?$/`
`29`	`30`	`constconventionRegexp=context.options[0] ?newRegExp(context.options[0]) :defaultRegexp`
`30`	`31`	`constignoreExporting=context.options[1] ?context.options[1] :false`
`31`	`32`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ export default [`
`13`	`13`	`'github/no-then':'error',`
`14`	`14`	`'github/no-blur':'error',`
`15`	`15`	`'github/async-preventdefault':'error',`
	`16`	`+'github/filenames-match-regex':['error','^([a-z0-9]+)([A-Z][a-z0-9]+)*$'],`
`16`	`17`	`},`
`17`	`18`	`},`
`18`	`19`	`]`

Comments

(0)