@rikalabs/repo-lint 0.1.0 → 0.2.0

package/index.js

@@ -7,3 +7,13 @@ module.exports.many = (optsOrChild, child) => {
   if (child) return { type: "many", ...optsOrChild, child };
   return { type: "many", child: optsOrChild };
 };
+module.exports.recursive = (optsOrChild, child) => {
+  if (child) return { type: "recursive", ...optsOrChild, child };
+  return { type: "recursive", maxDepth: 10, child: optsOrChild };
+};
+module.exports.either = (...variants) => ({ type: "either", variants });
+
+const presets = require('./presets/index.js');
+module.exports.nextjsAppRouter = presets.nextjsAppRouter;
+module.exports.nextjsDefaultIgnore = presets.nextjsDefaultIgnore;
+module.exports.nextjsDefaultIgnorePaths = presets.nextjsDefaultIgnorePaths;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rikalabs/repo-lint",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "High-performance filesystem layout linter with TypeScript DSL config",
   "license": "MIT",
   "repository": {
@@ -29,7 +29,8 @@
     "index.js",
     "install.js",
     "bin",
-    "types"
+    "types",
+    "presets"
   ],
   "scripts": {
     "postinstall": "node install.js"

package/presets/index.js

@@ -0,0 +1,11 @@
+const {
+  nextjsAppRouter,
+  nextjsDefaultIgnore,
+  nextjsDefaultIgnorePaths,
+} = require('./nextjs.js');
+
+module.exports = {
+  nextjsAppRouter,
+  nextjsDefaultIgnore,
+  nextjsDefaultIgnorePaths,
+};

package/presets/nextjs.js

@@ -0,0 +1,97 @@
+const { dir, file, opt, param, many, recursive, either } = require('../index.js');
+
+function nextjsAppRouter(options = {}) {
+  const routeCase = options.routeCase ?? 'kebab';
+  const maxDepth = options.maxDepth ?? 10;
+
+  const routeFiles = dir({
+    'page.tsx': opt(file()),
+    'layout.tsx': opt(file()),
+    'loading.tsx': opt(file()),
+    'error.tsx': opt(file()),
+    'not-found.tsx': opt(file()),
+    'template.tsx': opt(file()),
+    'default.tsx': opt(file()),
+    'route.ts': opt(file()),
+    'opengraph-image.tsx': opt(file()),
+    'twitter-image.tsx': opt(file()),
+    'sitemap.ts': opt(file()),
+    'robots.ts': opt(file()),
+  });
+
+  return dir({
+    src: opt(dir({
+      app: dir({
+        $routes: recursive(
+          { maxDepth },
+          param({ case: routeCase }, routeFiles)
+        ),
+        'layout.tsx': file(),
+        'page.tsx': opt(file()),
+        'globals.css': opt(file()),
+      }),
+      components: opt(dir({
+        $component: many(
+          { case: 'pascal' },
+          either(
+            file('*.tsx'),
+            dir({
+              'index.tsx': file(),
+              $files: many(file('*.tsx')),
+            })
+          )
+        ),
+      })),
+      lib: opt(dir({
+        $file: many(file('*.ts')),
+      })),
+      hooks: opt(dir({
+        $hook: many(file('use*.ts')),
+      })),
+      styles: opt(dir({
+        $style: many(file('*.css')),
+      })),
+    })),
+    app: opt(dir({
+      $routes: recursive(
+        { maxDepth },
+        param({ case: routeCase }, routeFiles)
+      ),
+      'layout.tsx': file(),
+      'page.tsx': opt(file()),
+      'globals.css': opt(file()),
+    })),
+    public: opt(dir({
+      $asset: many(file()),
+    })),
+    'next.config.js': opt(file()),
+    'next.config.mjs': opt(file()),
+    'next.config.ts': opt(file()),
+    'tailwind.config.js': opt(file()),
+    'tailwind.config.ts': opt(file()),
+    'postcss.config.js': opt(file()),
+    'postcss.config.mjs': opt(file()),
+    'tsconfig.json': opt(file()),
+    'package.json': file(),
+  });
+}
+
+function nextjsDefaultIgnore() {
+  return ['.next', 'node_modules', '.turbo', 'out', '.vercel'];
+}
+
+function nextjsDefaultIgnorePaths() {
+  return [
+    '**/.next/**',
+    '**/node_modules/**',
+    '**/.turbo/**',
+    '**/out/**',
+    '**/.vercel/**',
+  ];
+}
+
+module.exports = {
+  nextjsAppRouter,
+  nextjsDefaultIgnore,
+  nextjsDefaultIgnorePaths,
+};

package/types/index.d.ts

@@ -4,13 +4,17 @@ export interface DefineConfigOptions {
   rules?: RulesConfig;
   boundaries?: BoundariesConfig;
   deps?: DepsConfig;
+  ignore?: string[];
+  useGitignore?: boolean;
 }
 
 export type LayoutNode =
   | DirNode
   | FileNode
   | ParamNode
-  | ManyNode;
+  | ManyNode
+  | RecursiveNode
+  | EitherNode;
 
 export interface DirNode {
   type: "dir";
@@ -37,11 +41,23 @@ export interface ManyNode {
   child: LayoutNode;
 }
 
+export interface RecursiveNode {
+  type: "recursive";
+  maxDepth?: number;
+  child: LayoutNode;
+}
+
+export interface EitherNode {
+  type: "either";
+  variants: LayoutNode[];
+}
+
 export type CaseStyle = "kebab" | "snake" | "camel" | "pascal" | "any";
 
 export interface RulesConfig {
   forbidPaths?: string[];
   forbidNames?: string[];
+  ignorePaths?: string[];
 }
 
 export interface BoundariesConfig {
@@ -72,3 +88,17 @@ export function many(
   options: { case?: CaseStyle } | LayoutNode,
   child?: LayoutNode
 ): ManyNode;
+export function recursive(
+  options: { maxDepth?: number } | LayoutNode,
+  child?: LayoutNode
+): RecursiveNode;
+export function either(...variants: LayoutNode[]): EitherNode;
+
+export interface NextjsAppRouterOptions {
+  routeCase?: CaseStyle;
+  maxDepth?: number;
+}
+
+export function nextjsAppRouter(options?: NextjsAppRouterOptions): DirNode;
+export function nextjsDefaultIgnore(): string[];
+export function nextjsDefaultIgnorePaths(): string[];