Skip to content

Commit c216670

Browse files
eastdraconiseastdraconis
authored
fix: ignore dots inside brackets when extracting basename (#64)
* test: add Next.js dynamic routes support for filename-naming-convention rule on POSIX and Windows * fix: ignore dots inside brackets when extracting basename Previously, getBasename would treat dots inside brackets as extension separators. This commit adds logic to skip dots that appear within bracket pairs, ensuring they are treated as part of the filename rather than extension delimiters. * test: add tests for POSIX and Windows * refactor: remove redundant guard in getBasename
1 parent ed88e9f commit c216670

File tree

3 files changed

+175
-5
lines changed

3 files changed

+175
-5
lines changed

‎lib/utils/filename.js‎

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,29 @@ export const getFolderPath = (p) => posix.join(posix.dirname(p), posix.sep);
2424
* @param {string} filename filename without path
2525
* @param {boolean} [ignoreMiddleExtensions] flag to ignore middle extensions
2626
*/
27-
export const getBasename = (filename, ignoreMiddleExtensions = false) =>
28-
filename.substring(
29-
0,
30-
ignoreMiddleExtensions ? filename.indexOf('.') : filename.lastIndexOf('.')
31-
);
27+
export const getBasename = (filename, ignoreMiddleExtensions = false) => {
28+
const findDotsOutsideBrackets = (str) => {
29+
const positions = [];
30+
let depth = 0;
31+
32+
for (let i = 0; i < str.length; i++) {
33+
if (str[i] === '[') depth++;
34+
else if (str[i] === ']') depth--;
35+
else if (str[i] === '.' && depth === 0) {
36+
positions.push(i);
37+
}
38+
}
39+
return positions;
40+
};
41+
42+
const dotPositions = findDotsOutsideBrackets(filename);
43+
44+
const curPosition = ignoreMiddleExtensions
45+
? dotPositions[0]
46+
: dotPositions[dotPositions.length - 1];
47+
48+
return filename.substring(0, curPosition);
49+
};
3250

3351
/**
3452
* @returns {string[]} all folders

‎tests/lib/rules/filename-naming-convention.posix.js‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -804,6 +804,82 @@ ruleTester.run(
804804
}
805805
);
806806

807+
ruleTester.run(
808+
"filename-naming-convention with Next.js dynamic routes and option: [{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' }, { ignoreMiddleExtensions: true }]",
809+
rule,
810+
{
811+
valid: [
812+
{
813+
code: "var foo = 'bar';",
814+
filename: 'src/pages/blog/[[...userId]].tsx',
815+
options: [
816+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
817+
{ ignoreMiddleExtensions: true },
818+
],
819+
},
820+
{
821+
code: "var foo = 'bar';",
822+
filename: 'src/pages/blog/[[...slug]].tsx',
823+
options: [
824+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
825+
{ ignoreMiddleExtensions: true },
826+
],
827+
},
828+
{
829+
code: "var foo = 'bar';",
830+
filename: 'src/pages/blog/[...params].tsx',
831+
options: [
832+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
833+
{ ignoreMiddleExtensions: true },
834+
],
835+
},
836+
{
837+
code: "var foo = 'bar';",
838+
filename: 'src/pages/user/[id].tsx',
839+
options: [
840+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
841+
{ ignoreMiddleExtensions: true },
842+
],
843+
},
844+
{
845+
code: "var foo = 'bar';",
846+
filename: 'src/pages/post/[postId].test.tsx',
847+
options: [
848+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
849+
{ ignoreMiddleExtensions: true },
850+
],
851+
},
852+
{
853+
code: "var foo = 'bar';",
854+
filename: 'src/pages/api/user.test.ts',
855+
options: [
856+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
857+
{ ignoreMiddleExtensions: true },
858+
],
859+
},
860+
],
861+
862+
invalid: [
863+
{
864+
code: "var foo = 'bar';",
865+
filename: 'src/pages/blog/Invalid_Name.tsx',
866+
options: [
867+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
868+
{ ignoreMiddleExtensions: true },
869+
],
870+
errors: [
871+
{
872+
message:
873+
'The filename "Invalid_Name.tsx" does not match the "NEXT_JS_PAGE_ROUTER_FILENAME_CASE" pattern',
874+
column: 1,
875+
line: 1,
876+
},
877+
],
878+
},
879+
],
880+
}
881+
);
882+
807883
ruleTester.run(
808884
"filename-naming-convention with option: [{ '**/*.js': '__+([a-z])', '**/*.jsx': '__+([a-z])' }]",
809885
rule,

‎tests/lib/rules/filename-naming-convention.windows.js‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -826,6 +826,82 @@ ruleTester.run(
826826
}
827827
);
828828

829+
ruleTester.run(
830+
"filename-naming-convention with Next.js dynamic routes and option on Windows: [{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' }, { ignoreMiddleExtensions: true }]",
831+
rule,
832+
{
833+
valid: [
834+
{
835+
code: "var foo = 'bar';",
836+
filename: 'src\\pages\\blog\\[[...userId]].tsx',
837+
options: [
838+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
839+
{ ignoreMiddleExtensions: true },
840+
],
841+
},
842+
{
843+
code: "var foo = 'bar';",
844+
filename: 'src\\pages\\blog\\[[...slug]].tsx',
845+
options: [
846+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
847+
{ ignoreMiddleExtensions: true },
848+
],
849+
},
850+
{
851+
code: "var foo = 'bar';",
852+
filename: 'src\\pages\\blog\\[...params].tsx',
853+
options: [
854+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
855+
{ ignoreMiddleExtensions: true },
856+
],
857+
},
858+
{
859+
code: "var foo = 'bar';",
860+
filename: 'src\\pages\\user\\[id].tsx',
861+
options: [
862+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
863+
{ ignoreMiddleExtensions: true },
864+
],
865+
},
866+
{
867+
code: "var foo = 'bar';",
868+
filename: 'src\\pages\\post\\[postId].test.tsx',
869+
options: [
870+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
871+
{ ignoreMiddleExtensions: true },
872+
],
873+
},
874+
{
875+
code: "var foo = 'bar';",
876+
filename: 'src\\pages\\api\\user.test.ts',
877+
options: [
878+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
879+
{ ignoreMiddleExtensions: true },
880+
],
881+
},
882+
],
883+
884+
invalid: [
885+
{
886+
code: "var foo = 'bar';",
887+
filename: 'src\\pages\\blog\\Invalid_Name.tsx',
888+
options: [
889+
{ '**/*.{js,jsx,ts,tsx}': 'NEXT_JS_PAGE_ROUTER_FILENAME_CASE' },
890+
{ ignoreMiddleExtensions: true },
891+
],
892+
errors: [
893+
{
894+
message:
895+
'The filename "Invalid_Name.tsx" does not match the "NEXT_JS_PAGE_ROUTER_FILENAME_CASE" pattern',
896+
column: 1,
897+
line: 1,
898+
},
899+
],
900+
},
901+
],
902+
}
903+
);
904+
829905
ruleTester.run(
830906
"filename-naming-convention with option on Windows: [{ '**/*.js': 'CAMEL_CASE' }, { ignoreMiddleExtensions: true }]",
831907
rule,

0 commit comments

Comments
 (0)