feat(#23): only rule folder-naming-convention support NEXT_JS_APP_ROUTER_CASE

Author: dukeluo

lib/constants/naming-convention.js

@@ -34,42 +34,11 @@ const SCREAMING_SNAKE_CASE = '+([A-Z])*([A-Z0-9])*(_+([A-Z0-9]))';
  */
 const FLAT_CASE = '+([a-z0-9])';
 
-/**
- * @example [helpPageId]
- */
-const NEXTJS_DYNAMIC_SEGMENTS = `\\[${CAMEL_CASE}\\]`;
-
-/**
- * @example [...auth]
- */
-const NEXTJS_CATCH_ALL_SEGMENTS = `\\[...${CAMEL_CASE}\\]`;
-
-/**
- * @example [[...auth]]
- */
-const NEXTJS_OPTIONAL_CATCH_ALL_SEGMENTS = `\\[\\[...${CAMEL_CASE}\\]\\]`;
-
-/**
- * @example (auth)
- */
-const NEXTJS_ROUTE_GROUPS = `\\(${KEBAB_CASE}\\)`;
-
-/**
- * @example \@feed
- */
-const NEXTJS_NAMED_SLOTS = `\\@${KEBAB_CASE}`;
-
-/**
- * @example app, [helpPageId], [...auth], [[...auth]], (auth), \@feed
- */
-const NEXT_JS_APP_ROUTER_CASE = `@(${KEBAB_CASE}|${NEXTJS_DYNAMIC_SEGMENTS}|${NEXTJS_CATCH_ALL_SEGMENTS}|${NEXTJS_OPTIONAL_CATCH_ALL_SEGMENTS}|${NEXTJS_ROUTE_GROUPS}|${NEXTJS_NAMED_SLOTS})`;
-
 module.exports = {
   CAMEL_CASE,
   PASCAL_CASE,
   SNAKE_CASE,
   KEBAB_CASE,
   SCREAMING_SNAKE_CASE,
   FLAT_CASE,
-  NEXT_JS_APP_ROUTER_CASE,
 };

lib/constants/next-js-naming-convention.js

@@ -0,0 +1,41 @@
+/**
+ * @file Built in next js app router naming convention
+ * @author Huan Luo
+ */
+'use strict';
+
+const { CAMEL_CASE, KEBAB_CASE } = require('./naming-convention');
+
+/**
+ * @example [helpPageId]
+ */
+const NEXT_JS_DYNAMIC_SEGMENTS = `\\[${CAMEL_CASE}\\]`;
+
+/**
+ * @example [...auth]
+ */
+const NEXT_JS_CATCH_ALL_SEGMENTS = `\\[...${CAMEL_CASE}\\]`;
+
+/**
+ * @example [[...auth]]
+ */
+const NEXT_JS_OPTIONAL_CATCH_ALL_SEGMENTS = `\\[\\[...${CAMEL_CASE}\\]\\]`;
+
+/**
+ * @example (auth)
+ */
+const NEXT_JS_ROUTE_GROUPS = `\\(${KEBAB_CASE}\\)`;
+
+/**
+ * @example \@feed
+ */
+const NEXT_JS_NAMED_SLOTS = `\\@${KEBAB_CASE}`;
+
+/**
+ * @example app, [helpPageId], [...auth], [[...auth]], (auth), \@feed
+ */
+const NEXT_JS_APP_ROUTER_CASE = `@(${KEBAB_CASE}|${NEXT_JS_DYNAMIC_SEGMENTS}|${NEXT_JS_CATCH_ALL_SEGMENTS}|${NEXT_JS_OPTIONAL_CATCH_ALL_SEGMENTS}|${NEXT_JS_ROUTE_GROUPS}|${NEXT_JS_NAMED_SLOTS})`;
+
+module.exports = {
+  NEXT_JS_APP_ROUTER_CASE,
+};

lib/rules/folder-naming-convention.js

@@ -13,12 +13,13 @@ const {
 } = require('../utils/filename');
 const {
   validateNamingPatternObject,
-  namingPatternValidator,
   globPatternValidator,
+  folderNamingPatternValidator,
 } = require('../utils/validation');
 const { getDocUrl } = require('../utils/doc');
 const { isNotEmpty, isNil } = require('../utils/utility');
-const NAMING_CONVENTION = require('../constants/naming-convention');
+const BASIC_NAMING_CONVENTION = require('../constants/naming-convention');
+const NEXT_JS_NAMING_CONVENTION = require('../constants/next-js-naming-convention');
 const {
   FOLDER_NAMING_CONVENTION_ERROR_MESSAGE,
 } = require('../constants/message');
@@ -52,7 +53,7 @@ module.exports = {
         const message = validateNamingPatternObject(
           rules,
           globPatternValidator,
-          namingPatternValidator
+          folderNamingPatternValidator
         );
 
         if (message) {
@@ -87,7 +88,9 @@ module.exports = {
               if (
                 !micromatch.isMatch(
                   folder,
-                  NAMING_CONVENTION[namingPattern] || namingPattern
+                  BASIC_NAMING_CONVENTION[namingPattern] ||
+                    NEXT_JS_NAMING_CONVENTION[namingPattern] ||
+                    namingPattern
                 )
               ) {
                 context.report({

lib/utils/validation.js

@@ -5,7 +5,8 @@
 'use strict';
 
 const isGlob = require('is-glob');
-const NAMING_CONVENTION = require('../constants/naming-convention');
+const BASIC_NAMING_CONVENTION = require('../constants/naming-convention');
+const NEXT_JS_NAMING_CONVENTION = require('../constants/next-js-naming-convention');
 const { PREFINED_MATCH_SYNTAX_REGEXP } = require('../constants/regex');
 const { isObject } = require('./utility');
 const {
@@ -42,32 +43,43 @@ const validateNamingPatternObject = (config, keyValidator, valueValidator) => {
  * @returns {boolean} true if pattern is a valid naming pattern
  * @param {string} namingPattern pattern string
  */
-const namingPatternValidator = (namingPattern) => {
-  const buildInPatterns = Object.keys(NAMING_CONVENTION);
-
-  return isGlob(namingPattern) || buildInPatterns.includes(namingPattern);
-};
+const basicNamingPatternValidator = (namingPattern) =>
+  Object.keys(BASIC_NAMING_CONVENTION).includes(namingPattern);
 
 /**
- * @returns {boolean} true if pattern is a valid filename naming pattern
+ * @returns {boolean} true if pattern is a valid naming pattern
  * @param {string} namingPattern pattern string
  */
-const filenameNamingPatternValidator = (namingPattern) => {
-  return (
-    namingPatternValidator(namingPattern) ||
-    PREFINED_MATCH_SYNTAX_REGEXP.test(namingPattern)
-  );
-};
+const nextJsNamingPatternValidator = (namingPattern) =>
+  Object.keys(NEXT_JS_NAMING_CONVENTION).includes(namingPattern);
 
 /**
  * @returns {boolean} true if pattern is a valid glob pattern
  * @param {string} pattern pattern string
  */
 const globPatternValidator = isGlob;
 
+/**
+ * @returns {boolean} true if pattern is a valid filename naming pattern
+ * @param {string} namingPattern pattern string
+ */
+const filenameNamingPatternValidator = (namingPattern) =>
+  globPatternValidator(namingPattern) ||
+  basicNamingPatternValidator(namingPattern) ||
+  PREFINED_MATCH_SYNTAX_REGEXP.test(namingPattern);
+
+/**
+ * @returns {boolean} true if pattern is a valid filename naming pattern
+ * @param {string} namingPattern pattern string
+ */
+const folderNamingPatternValidator = (namingPattern) =>
+  globPatternValidator(namingPattern) ||
+  basicNamingPatternValidator(namingPattern) ||
+  nextJsNamingPatternValidator(namingPattern);
+
 module.exports = {
   validateNamingPatternObject,
-  namingPatternValidator,
-  filenameNamingPatternValidator,
   globPatternValidator,
+  filenameNamingPatternValidator,
+  folderNamingPatternValidator,
 };