my-gadgetry 1.0.12 → 1.2.1

package/dist/_core/fs.d.ts

@@ -1 +1,18 @@
-export declare const getAllFiles: (dir: string, _files?: string[]) => string[];
+export interface Options {
+    include?: string[];
+    exclude?: string[];
+    depth?: number;
+    startDir?: string;
+}
+export declare const OPTIONS: {
+    include: never[];
+    exclude: never[];
+    depth: number;
+};
+export interface Stacks {
+    files: string[];
+    depth: number;
+}
+export declare const getDepth: (path: string) => number;
+export declare const isShallow: (from: string, to: string, depth: number) => boolean;
+export declare const getAllFiles: (startDir: string, _options?: Options) => string[];

package/dist/_core/fs.js

@@ -1,14 +1,59 @@
 import { statSync, readdirSync } from 'fs';
-export const getAllFiles = (dir, _files = []) => {
+import { relative } from 'path';
+import { minimatch } from 'minimatch';
+export const OPTIONS = {
+    include: [],
+    exclude: [],
+    depth: 0,
+};
+const isMatch = (path, patterns) => {
+    return patterns.some(pattern => minimatch(path, pattern));
+};
+export const getDepth = (path) => {
+    if (!path) {
+        return 0;
+    }
+    let depth = 0;
+    for (const p of path.replace(/^\.?\/(.*$)/, '$1').split('/')) {
+        switch (p) {
+            case '..':
+                --depth;
+                break;
+            default:
+                ++depth;
+                break;
+        }
+    }
+    return depth;
+};
+export const isShallow = (from, to, depth) => {
+    return getDepth(relative(from, to)) <= depth;
+};
+const _getAllFiles = (dir, options, _files = []) => {
     const files = readdirSync(dir);
     for (const file of files) {
-        const name = dir + '/' + file;
+        const name = `${dir}/${file}`;
+        if (isMatch(name, options.exclude)) {
+            continue;
+        }
+        if (options.depth >= 1 && !isShallow(options.startDir, name, options.depth)) {
+            continue;
+        }
         if (statSync(name).isDirectory()) {
-            getAllFiles(name, _files);
+            _getAllFiles(name, options, _files);
         }
         else {
+            if (options.include.length > 0 && !isMatch(name, options.include)) {
+                continue;
+            }
             _files.push(name);
         }
     }
     return _files;
 };
+export const getAllFiles = (startDir, _options) => {
+    if (!!_options && 'depth' in _options && typeof _options.depth !== 'undefined' && _options.depth < 1) {
+        throw new Error('Invalid depth, must be greater than 0');
+    }
+    return _getAllFiles(startDir, { ...OPTIONS, ...(_options || {}), startDir });
+};

package/dist/_core/types/utilities.d.ts

@@ -0,0 +1,10 @@
+export type Merge<T> = {
+    [K in keyof T]: T[K];
+};
+export type AddOR<T, K extends keyof T, V> = Merge<Omit<T, K> & {
+    [key in K]: T[K] | V;
+}>;
+export type Update<T, K extends keyof T, V> = Merge<Omit<T, K> & {
+    [key in K]: V;
+}>;
+export type ToRecord<T> = Record<keyof T, T[keyof T]>;

package/dist/_core/types/utilities.js

@@ -0,0 +1 @@
+export {};

package/dist/_internal/types/utilities.d.ts

@@ -0,0 +1 @@
+export * from '../../_core/types/utilities.js';

package/dist/_internal/types/utilities.js

@@ -0,0 +1 @@
+export * from '../../_core/types/utilities.js';

package/dist/modules/types/utilities.d.ts

@@ -0,0 +1 @@
+export * from '../../_internal/types/utilities.js';

package/dist/modules/types/utilities.js

@@ -0,0 +1 @@
+export * from '../../_internal/types/utilities.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "my-gadgetry",
   "type": "module",
-  "version": "1.0.12",
+  "version": "1.2.1",
   "description": "",
   "author": "",
   "repository": {
@@ -29,20 +29,17 @@
     "tsc": "tsc -p tsconfig.publish.json && tsc-alias -p tsconfig.publish.json",
     "generate": "tsx --tsconfig ./tsconfig.zx.json ./tools/generate-alias.zx.ts",
     "ci:update-version": "tsx --tsconfig ./tsconfig.zx.json ./tools/update-version.zx.ts",
-
     "//--- test ---//": "",
     "test": "run-s test:*",
     "test:lint": "npm run lint",
     "test:prettier": "npm run prettier:check",
     "test:jest": "npm run jest",
-
     "//--- build ---//": "",
     "build": "run-s build:*",
     "build:test": "npm run test",
     "build:clean": "npm run clean",
     "build:tsc": "npm run tsc",
     "build:generate": "npm run generate",
-
     "//--- publish ---//": "",
     "publish:build": "run-s build:{clean,tsc,generate}"
   },
@@ -51,12 +48,13 @@
     "@actions/exec": "^1.1.1",
     "@actions/github": "^6.0.0",
     "fs-extra": "^11.2.0",
-    "zx": "^8.1.0"
+    "minimatch": "^9.0.4",
+    "zx": "^8.1.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.5",
-    "@babel/preset-env": "^7.24.5",
-    "@babel/preset-typescript": "^7.24.1",
+    "@babel/core": "^7.24.6",
+    "@babel/preset-env": "^7.24.6",
+    "@babel/preset-typescript": "^7.24.6",
     "@eslint/js": "^8.57.0",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.12.12",
@@ -71,15 +69,15 @@
     "eslint-plugin-unused-imports": "^3.2.0",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
-    "lint-staged": "^15.2.2",
-    "npm-run-all2": "^6.1.2",
+    "lint-staged": "^15.2.5",
+    "npm-run-all2": "^6.2.0",
     "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.1.3",
     "ts-node": "^10.9.2",
     "tsc-alias": "^1.8.10",
-    "tsx": "^4.10.2",
+    "tsx": "^4.11.0",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^7.9.0"
+    "typescript-eslint": "^7.10.0"
   },
   "exports": {
     ".": "./dist/**/*.js",
@@ -90,6 +88,7 @@
     "./dev-ops/package-generator/generate-alias": "./dist/modules/dev-ops/package-generator/generate-alias.js",
     "./fs": "./dist/modules/fs.js",
     "./type-check": "./dist/modules/type-check.js",
+    "./types/utilities": "./dist/modules/types/utilities.js",
     "./package.json": "./package.json"
   },
   "files": [

package/src/_core/__tests__/fs/get-all-files.spec.ts

@@ -0,0 +1,90 @@
+import { resolve, join } from 'path'
+import { getAllFiles } from '../../fs.js'
+
+describe('getAllFiles', () => {
+  const path = resolve(__dirname, '../../../..', 'fs-test')
+  it('no exclude & include', () => {
+    const exclude: string[] = []
+    const include: string[] = []
+    const expects = [
+      join(path, 'foo/piyo/index.ts'),
+      join(path, 'foo/piyo.ts'),
+      join(path, 'foo.ts'),
+      join(path, 'hoge/foo/piyo/index.ts'),
+      join(path, 'hoge/foo/piyo.ts'),
+      join(path, 'hoge/foo.ts'),
+      join(path, 'hoge.ts'),
+    ]
+    expect(JSON.stringify(getAllFiles(path, { include, exclude }))).toBe(JSON.stringify(expects))
+  })
+  describe('set exclude', () => {
+    it('filename', () => {
+      const exclude: string[] = ['**/index.ts']
+      const include: string[] = []
+      const expects = [
+        join(path, 'foo/piyo.ts'),
+        join(path, 'foo.ts'),
+        join(path, 'hoge/foo/piyo.ts'),
+        join(path, 'hoge/foo.ts'),
+        join(path, 'hoge.ts'),
+      ]
+      expect(JSON.stringify(getAllFiles(path, { include, exclude }))).toBe(JSON.stringify(expects))
+    })
+    it('dirname', () => {
+      const exclude: string[] = ['**/piyo/**/*']
+      const include: string[] = []
+      const expects = [
+        join(path, 'foo/piyo.ts'),
+        join(path, 'foo.ts'),
+        join(path, 'hoge/foo/piyo.ts'),
+        join(path, 'hoge/foo.ts'),
+        join(path, 'hoge.ts'),
+      ]
+      expect(JSON.stringify(getAllFiles(path, { include, exclude }))).toBe(JSON.stringify(expects))
+    })
+  })
+  describe('set include', () => {
+    it('filename', () => {
+      const exclude: string[] = []
+      const include: string[] = ['**/index.ts']
+      const expects = [join(path, 'foo/piyo/index.ts'), join(path, 'hoge/foo/piyo/index.ts')]
+      expect(JSON.stringify(getAllFiles(path, { include, exclude }))).toBe(JSON.stringify(expects))
+    })
+    it('dirname', () => {
+      const exclude: string[] = []
+      const include: string[] = ['**/foo/**/*']
+      const expects = [
+        join(path, 'foo/piyo/index.ts'),
+        join(path, 'foo/piyo.ts'),
+        join(path, 'hoge/foo/piyo/index.ts'),
+        join(path, 'hoge/foo/piyo.ts'),
+      ]
+      expect(JSON.stringify(getAllFiles(path, { include, exclude }))).toBe(JSON.stringify(expects))
+    })
+  })
+  describe('set include & exclude', () => {
+    it('filename & dirname', () => {
+      const exclude: string[] = ['**/p*.ts']
+      const include: string[] = ['**/foo/**/*']
+      const expects = [join(path, 'foo/piyo/index.ts'), join(path, 'hoge/foo/piyo/index.ts')]
+      expect(JSON.stringify(getAllFiles(path, { include, exclude }))).toBe(JSON.stringify(expects))
+    })
+  })
+  describe('set depth', () => {
+    it('1', () => {
+      const exclude: string[] = []
+      const include: string[] = []
+      const depth = 1
+      const expects = [join(path, 'foo.ts'), join(path, 'hoge.ts')]
+      expect(JSON.stringify(getAllFiles(path, { include, exclude, depth }))).toBe(JSON.stringify(expects))
+    })
+    it('0: toThrow', () => {
+      const exclude: string[] = []
+      const include: string[] = []
+      const depth = 0
+      expect(() => getAllFiles(join(path, 'foo'), { include, exclude, depth })).toThrow(
+        'Invalid depth, must be greater than 0'
+      )
+    })
+  })
+})

package/src/_core/__tests__/fs/get-depth.spec.ts

@@ -0,0 +1,46 @@
+import { getDepth } from '../../fs.js'
+
+describe('getDepth', () => {
+  describe('shallow', () => {
+    it('root', () => {
+      expect(getDepth('hoge')).toBe(1)
+    })
+    it('/', () => {
+      expect(getDepth('hoge')).toBe(1)
+    })
+    it('.', () => {
+      expect(getDepth('./hoge')).toBe(1)
+    })
+    it('..', () => {
+      expect(getDepth('../hoge')).toBe(0)
+    })
+  })
+  describe('deep', () => {
+    it('root', () => {
+      expect(getDepth('hoge/foo')).toBe(2)
+    })
+    it('/', () => {
+      expect(getDepth('foo/hoge')).toBe(2)
+    })
+    it('.', () => {
+      expect(getDepth('./foo/hoge')).toBe(2)
+    })
+    it('..', () => {
+      expect(getDepth('../foo/hoge')).toBe(1)
+    })
+  })
+  describe('deep/filename', () => {
+    it('root', () => {
+      expect(getDepth('hoge/foo/piyo.js')).toBe(3)
+    })
+    it('/', () => {
+      expect(getDepth('foo/hoge/piyo.js')).toBe(3)
+    })
+    it('.', () => {
+      expect(getDepth('./foo/hoge/piyo.js')).toBe(3)
+    })
+    it('..', () => {
+      expect(getDepth('../foo/hoge/piyo.js')).toBe(2)
+    })
+  })
+})

package/src/_core/__tests__/fs/is-shallow.spec.ts

@@ -0,0 +1,13 @@
+import { isShallow } from '../../fs.js'
+import { resolve } from 'path'
+
+const path = resolve(__dirname, '../../../..', 'fs-test')
+
+describe('isShallow', () => {
+  it('depth: 1', () => {
+    expect(isShallow(path, `${path}/foo`, 1)).toBeTruthy()
+  })
+  it('same path', () => {
+    expect(isShallow(path, path, 0)).toBeTruthy()
+  })
+})

package/src/_core/fs.ts

@@ -1,14 +1,77 @@
 import { statSync, readdirSync } from 'fs'
+import { relative } from 'path'
 
-export const getAllFiles = (dir: string, _files: string[] = []) => {
+import { minimatch } from 'minimatch'
+
+export interface Options {
+  include?: string[]
+  exclude?: string[]
+  depth?: number
+  startDir?: string
+}
+
+export const OPTIONS = {
+  include: [],
+  exclude: [],
+  depth: 0,
+}
+
+export interface Stacks {
+  files: string[]
+  depth: number
+}
+
+const isMatch = (path: string, patterns: string[]) => {
+  return patterns.some(pattern => minimatch(path, pattern))
+}
+
+export const getDepth = (path: string) => {
+  if (!path) {
+    return 0
+  }
+  let depth = 0
+  for (const p of path.replace(/^\.?\/(.*$)/, '$1').split('/')) {
+    switch (p) {
+      case '..':
+        --depth
+        break
+      default:
+        ++depth
+        break
+    }
+  }
+  return depth
+}
+
+export const isShallow = (from: string, to: string, depth: number) => {
+  return getDepth(relative(from, to)) <= depth
+}
+
+const _getAllFiles = (dir: string, options: Required<Options>, _files: string[] = []) => {
   const files = readdirSync(dir)
   for (const file of files) {
-    const name = dir + '/' + file
+    const name = `${dir}/${file}`
+    if (isMatch(name, options.exclude)) {
+      continue
+    }
+    if (options.depth >= 1 && !isShallow(options.startDir, name, options.depth)) {
+      continue
+    }
     if (statSync(name).isDirectory()) {
-      getAllFiles(name, _files)
+      _getAllFiles(name, options, _files)
     } else {
+      if (options.include.length > 0 && !isMatch(name, options.include)) {
+        continue
+      }
       _files.push(name)
     }
   }
   return _files
 }
+
+export const getAllFiles = (startDir: string, _options?: Options) => {
+  if (!!_options && 'depth' in _options && typeof _options.depth !== 'undefined' && _options.depth < 1) {
+    throw new Error('Invalid depth, must be greater than 0')
+  }
+  return _getAllFiles(startDir, { ...OPTIONS, ...(_options || {}), startDir })
+}

package/src/_core/types/utilities.ts

@@ -0,0 +1,17 @@
+export type Merge<T> = {
+  [K in keyof T]: T[K]
+}
+
+export type AddOR<T, K extends keyof T, V> = Merge<
+  Omit<T, K> & {
+    [key in K]: T[K] | V
+  }
+>
+
+export type Update<T, K extends keyof T, V> = Merge<
+  Omit<T, K> & {
+    [key in K]: V
+  }
+>
+
+export type ToRecord<T> = Record<keyof T, T[keyof T]>

package/src/_internal/types/utilities.ts

@@ -0,0 +1 @@
+export * from '~core/types/utilities.js'

package/src/modules/types/utilities.ts

@@ -0,0 +1 @@
+export * from '~internal/types/utilities.js'