@elnop/check-tree 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 elnop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,30 @@
-# Temporary Holding Version
+# @elnop/check-tree
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Checks the folders of a source tree, which a linter does not see:
+
+- no empty folder
+- a category folder (`components`, `hooks`, `stores`…) does not hold a single child: move the child up and delete the folder
+- a folder with more than one stylesheet puts them in a `styles/` folder, and a folder that has a `styles/` folder keeps no stylesheet next to it
+
+Test files (`*.test.ts`, `*.test.tsx`) are not counted.
+
+```sh
+npm install --save-dev @elnop/check-tree
+npx check-tree src
+```
+
+It prints one line per problem and exits with code 1 if it found any.
+
+The default category folders are `components`, `orchestrators`, `presenters`, `hooks`, `styles`, `types`, `configs`, `stores` and `lib`. Pass your own list with `--categories`:
+
+```sh
+npx check-tree src --categories components,hooks,utils
+```
+
+The check is also exported as a function:
+
+```ts
+import { treeViolations } from '@elnop/check-tree/treeViolations';
+
+const violations = treeViolations('src');
+```

package/dist/checkTree.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/checkTree.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+import { resolve } from 'node:path';
+import { parseArgs } from 'node:util';
+import { treeViolations } from './treeViolations.js';
+const { values, positionals } = parseArgs({ allowPositionals: true, options: { categories: { type: 'string' } } });
+const categories = values.categories?.split(',').map((category) => category.trim());
+const violations = treeViolations(resolve(positionals[0] ?? 'src'), categories);
+for (const violation of violations)
+    console.error(violation);
+process.exitCode = violations.length === 0 ? 0 : 1;

package/dist/treeViolations.d.ts

@@ -0,0 +1 @@
+export declare function treeViolations(root: string, categoryFolders?: readonly string[]): string[];

package/dist/treeViolations.js

@@ -0,0 +1,30 @@
+import { readdirSync } from 'node:fs';
+import { basename, join, relative } from 'node:path';
+const DEFAULT_CATEGORY_FOLDERS = ['components', 'orchestrators', 'presenters', 'hooks', 'styles', 'types', 'configs', 'stores', 'lib'];
+const TEST_FILE = /\.test\.tsx?$/;
+function folderViolations(folder, name, categoryFolders) {
+    const entries = readdirSync(folder, { withFileTypes: true });
+    const children = entries.filter((entry) => !TEST_FILE.test(entry.name));
+    const stylesheets = entries.filter((entry) => entry.isFile() && entry.name.endsWith('.css'));
+    const hasStylesFolder = entries.some((entry) => entry.isDirectory() && entry.name === 'styles');
+    const violations = [];
+    if (children.length === 0)
+        violations.push(`${name} is empty: delete it`);
+    if (children.length === 1 && categoryFolders.has(basename(folder)))
+        violations.push(`${name} holds a single child: move it up one level and delete the folder`);
+    if (stylesheets.length > 0 && hasStylesFolder)
+        violations.push(`${name} has a styles/ folder: move ${stylesheets.map((entry) => entry.name).join(', ')} into it`);
+    if (stylesheets.length > 1 && basename(folder) !== 'styles')
+        violations.push(`${name} holds ${stylesheets.length} stylesheets: move them into a styles/ folder`);
+    return violations;
+}
+export function treeViolations(root, categoryFolders = DEFAULT_CATEGORY_FOLDERS) {
+    const categories = new Set(categoryFolders);
+    const walk = (folder) => [
+        ...folderViolations(folder, relative(join(root, '..'), folder), categories),
+        ...readdirSync(folder, { withFileTypes: true })
+            .filter((entry) => entry.isDirectory())
+            .flatMap((entry) => walk(join(folder, entry.name))),
+    ];
+    return walk(root);
+}

package/package.json

@@ -1,6 +1,34 @@
 {
   "name": "@elnop/check-tree",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Checks a source tree: no empty folder, no category folder holding a single child, stylesheets grouped in styles/.",
+  "keywords": [
+    "lint",
+    "folder-structure",
+    "project-structure",
+    "cli"
+  ],
+  "homepage": "https://github.com/Elnop/eslint-plugins/tree/main/packages/tools/check-tree#readme",
+  "bugs": "https://github.com/Elnop/eslint-plugins/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Elnop/eslint-plugins.git",
+    "directory": "packages/tools/check-tree"
+  },
+  "license": "MIT",
+  "author": "elnop",
+  "type": "module",
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "bin": {
+    "check-tree": "./dist/checkTree.js"
+  },
+  "exports": {
+    "./treeViolations": "./dist/treeViolations.js"
+  },
+  "scripts": {
+    "test": "node --test '**/*.test.ts'"
+  }
+}