refactor: ♻️ move workspace on its own class
This commit is contained in:
Guz013
@@ -1,87 +1,9 @@
|
|||||||
#!node
|
#!node
|
||||||
import fs from 'node:fs/promises';
|
|
||||||
import path, { join } from 'node:path';
|
import path, { join } from 'node:path';
|
||||||
import { existsSync } from 'node:fs';
|
|
||||||
import { createSpinner } from 'nanospinner';
|
import { createSpinner } from 'nanospinner';
|
||||||
import glob from 'picomatch';
|
import glob from 'picomatch';
|
||||||
import YAML from 'yaml';
|
|
||||||
import c from 'picocolors';
|
import c from 'picocolors';
|
||||||
|
import Workspace from './workspace.js';
|
||||||
/**
|
|
||||||
* @template T
|
|
||||||
*
|
|
||||||
* @param {Promise<T>} promise - The async function to try running
|
|
||||||
* @returns {Promise<T | null>} - Returns the result of the async function, or null if it errors
|
|
||||||
*/
|
|
||||||
async function tryRun(promise) {
|
|
||||||
try {
|
|
||||||
return await promise;
|
|
||||||
}
|
|
||||||
catch (err) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} directory - The directory to find .gitignore and .eslintignore
|
|
||||||
* @returns {Promise<string[]>} - List of ignore glob patterns
|
|
||||||
*/
|
|
||||||
async function getIgnoredFiles(directory) {
|
|
||||||
const gitIgnore = (await tryRun(fs.readFile(join(directory, '.gitignore'), 'utf8')) ?? '')
|
|
||||||
.split('\n')
|
|
||||||
.filter(p => p && !p.startsWith('#'))
|
|
||||||
.map(p => join(directory, '**', p));
|
|
||||||
|
|
||||||
const eslintIgnore = (await tryRun(fs.readFile(join(directory, '.eslintignore'), 'utf8')) ?? '')
|
|
||||||
.split('\n')
|
|
||||||
.filter(p => p && !p.startsWith('#'))
|
|
||||||
.map(p => join(directory, '**', p));
|
|
||||||
|
|
||||||
return [...eslintIgnore, ...gitIgnore];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} directory - The directory to work in.
|
|
||||||
* @returns {Promise<string>} - The package name founded.
|
|
||||||
*/
|
|
||||||
async function getPackageName(directory) {
|
|
||||||
if (existsSync(join(directory, 'package.json'))) {
|
|
||||||
const file = await fs.readFile(join(directory, 'package.json'), 'utf8');
|
|
||||||
/** @type {{name?: string}} */
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
||||||
const obj = JSON.parse(file);
|
|
||||||
|
|
||||||
if (obj.name) return obj.name;
|
|
||||||
}
|
|
||||||
return path.normalize(directory).split('/').at(-1) ?? directory;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} directory - The directory path to work on
|
|
||||||
* @param {{files: string[], directories: string[]}} paths - The file list to be filtered
|
|
||||||
* @param {string[]} [packages] - The packages to be filtered
|
|
||||||
* @returns {Promise<import('./types').Package>} - The package object
|
|
||||||
*/
|
|
||||||
async function getRootPackage(directory, paths, packages = []) {
|
|
||||||
|
|
||||||
const ignorePatterns = [
|
|
||||||
...packages.map(p =>
|
|
||||||
`${join(directory, p, '**/*')}`,
|
|
||||||
)];
|
|
||||||
|
|
||||||
console.log(ignorePatterns);
|
|
||||||
|
|
||||||
return {
|
|
||||||
name: `${await getPackageName(directory)} [ROOT]`,
|
|
||||||
files: paths.files.filter(f =>
|
|
||||||
!glob.isMatch(f, ignorePatterns),
|
|
||||||
) ?? [],
|
|
||||||
directories: paths.directories.filter(d =>
|
|
||||||
!glob.isMatch(d, ignorePatterns),
|
|
||||||
) ?? [],
|
|
||||||
path: directory,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export default class Cli {
|
export default class Cli {
|
||||||
/** @type {string} */
|
/** @type {string} */
|
||||||
@@ -93,10 +15,14 @@ export default class Cli {
|
|||||||
/** @type {import('./types').Config[]} */
|
/** @type {import('./types').Config[]} */
|
||||||
configs;
|
configs;
|
||||||
|
|
||||||
|
/** @type {import('./types').Workspace | undefined} */
|
||||||
|
#workspace;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {{
|
* @param {{
|
||||||
* configs: import('./types').Config[]
|
* configs: import('./types').Config[]
|
||||||
* packages?: string[],
|
* packages?: string[],
|
||||||
|
* workspace?: import('./types').Workspace,
|
||||||
* directory?: string,
|
* directory?: string,
|
||||||
* debug?: boolean,
|
* debug?: boolean,
|
||||||
* }} options - Cli options
|
* }} options - Cli options
|
||||||
@@ -104,128 +30,11 @@ export default class Cli {
|
|||||||
constructor(options) {
|
constructor(options) {
|
||||||
this.configs = options?.configs;
|
this.configs = options?.configs;
|
||||||
this.packages = options.packages;
|
this.packages = options.packages;
|
||||||
|
this.#workspace = options.workspace;
|
||||||
this.dir = path.normalize(options.directory ?? this.dir);
|
this.dir = path.normalize(options.directory ?? this.dir);
|
||||||
this.debug = options.debug ?? this.debug;
|
this.debug = options.debug ?? this.debug;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @type {{files: string[], directories: string[]} | undefined} */
|
|
||||||
#paths;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} [directory] - The directory to work on
|
|
||||||
* @param {string[]} [ignores] - Glob patterns to ignore
|
|
||||||
* @returns {Promise<{files: string[], directories: string[]}>} - List of all files in the directory
|
|
||||||
*/
|
|
||||||
async getPaths(directory = this.dir, ignores = []) {
|
|
||||||
|
|
||||||
ignores.push(
|
|
||||||
...[
|
|
||||||
'.git',
|
|
||||||
'.dist',
|
|
||||||
'.DS_Store',
|
|
||||||
'node_modules',
|
|
||||||
].map((f) => join(directory, f)),
|
|
||||||
...await getIgnoredFiles(directory),
|
|
||||||
);
|
|
||||||
|
|
||||||
const paths = (await fs.readdir(directory))
|
|
||||||
.map((f) => path.normalize(join(directory, f)))
|
|
||||||
.filter((p) => !glob.isMatch(p, ignores));
|
|
||||||
|
|
||||||
/** @type {string[]} */
|
|
||||||
const files = [];
|
|
||||||
/** @type {string[]} */
|
|
||||||
const directories = [];
|
|
||||||
|
|
||||||
for (const path of paths) {
|
|
||||||
if ((await fs.lstat(path)).isDirectory()) {
|
|
||||||
const subPaths = await this.getPaths(path, ignores);
|
|
||||||
directories.push(path, ...subPaths.directories);
|
|
||||||
files.push(...subPaths.files);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
files.push(path);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return { files, directories };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @type {string[] | undefined} */
|
|
||||||
packages;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @returns {Promise<string[]>} - List of packages on a directory;
|
|
||||||
*/
|
|
||||||
async getPackages() {
|
|
||||||
|
|
||||||
/** @type {string[]} */
|
|
||||||
let packages = [];
|
|
||||||
|
|
||||||
const pnpmWorkspace =
|
|
||||||
existsSync(join(this.dir, 'pnpm-workspace.yaml'))
|
|
||||||
? 'pnpm-workspace.yaml'
|
|
||||||
: existsSync(join(this.dir, 'pnpm-workspace.yml'))
|
|
||||||
? 'pnpm-workspace.yml'
|
|
||||||
: null;
|
|
||||||
|
|
||||||
if (pnpmWorkspace) {
|
|
||||||
const fileYaml = await fs.readFile(join(this.dir, pnpmWorkspace), 'utf8');
|
|
||||||
|
|
||||||
/** @type {{packages?: string[]}} */
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
||||||
const fileObj = YAML.parse(fileYaml);
|
|
||||||
|
|
||||||
packages.push(...(fileObj?.packages ?? []));
|
|
||||||
}
|
|
||||||
else if (existsSync(join(this.dir, 'package.json'))) {
|
|
||||||
const packageJson = await fs.readFile(join(this.dir, 'package.json'), 'utf8');
|
|
||||||
|
|
||||||
/** @type {{workspaces?: string[]}} */
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
|
||||||
const packageObj = JSON.parse(packageJson);
|
|
||||||
|
|
||||||
packages.push(...(packageObj?.workspaces ?? []));
|
|
||||||
}
|
|
||||||
return packages;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @type {import('./types').Workspace | undefined} */
|
|
||||||
#workspace;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @returns {Promise<import('./types').Workspace>}
|
|
||||||
* The workspace structure and packages founded
|
|
||||||
*/
|
|
||||||
async getWorkspace() {
|
|
||||||
console.log(this.packages);
|
|
||||||
const rootPackage = await getRootPackage(this.dir, this.#paths ?? { files: [], directories: [] }, this.packages);
|
|
||||||
|
|
||||||
/** @type {string[]} */
|
|
||||||
const packagesPaths = this.#paths?.directories.filter(d =>
|
|
||||||
glob.isMatch(d, this.packages?.map(p => join(this.dir, p)) ?? ''),
|
|
||||||
) ?? [];
|
|
||||||
|
|
||||||
/** @type {import('./types').Package[]} */
|
|
||||||
const packages = [];
|
|
||||||
|
|
||||||
for (const pkgPath of packagesPaths) {
|
|
||||||
packages.push({
|
|
||||||
name: await getPackageName(pkgPath),
|
|
||||||
files: this.#paths?.files.filter(f => glob.isMatch(f, join(pkgPath, '**/*'))) ?? [],
|
|
||||||
directories: this.#paths?.directories.filter(f => glob.isMatch(f, join(pkgPath, '**/*'))) ?? [],
|
|
||||||
path: pkgPath,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
packages: [
|
|
||||||
rootPackage,
|
|
||||||
...packages,
|
|
||||||
],
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {import('./types').Package} pkg - The package to detect configs
|
* @param {import('./types').Package} pkg - The package to detect configs
|
||||||
* @returns {import('./types').Package['config']} - Detected configs record
|
* @returns {import('./types').Package['config']} - Detected configs record
|
||||||
@@ -302,18 +111,15 @@ export default class Cli {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async run() {
|
async run() {
|
||||||
|
const workspace = this.#workspace ?? await new Workspace(this.dir).get();
|
||||||
|
|
||||||
this.packages ||= await this.getPackages();
|
workspace.packages = workspace.packages.map(
|
||||||
this.#paths = await this.getPaths();
|
|
||||||
this.#workspace = await this.getWorkspace();
|
|
||||||
|
|
||||||
this.#workspace.packages = this.#workspace.packages.map(
|
|
||||||
pkg => {
|
pkg => {
|
||||||
pkg.config = this.detectConfig(pkg); return pkg;
|
pkg.config = this.detectConfig(pkg); return pkg;
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
console.log(JSON.stringify(this.#workspace.packages, null, 2));
|
console.log(JSON.stringify(workspace.packages, null, 2));
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
214
packages/cli/src/workspace.js
Normal file
214
packages/cli/src/workspace.js
Normal file
@@ -0,0 +1,214 @@
|
|||||||
|
import fs from 'node:fs/promises';
|
||||||
|
import { existsSync } from 'node:fs';
|
||||||
|
import YAML from 'yaml';
|
||||||
|
import path, { join } from 'node:path';
|
||||||
|
import glob from 'picomatch';
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @template T
|
||||||
|
*
|
||||||
|
* @param {Promise<T>} promise - The async function to try running
|
||||||
|
* @returns {Promise<T | null>} - Returns the result of the async function, or null if it errors
|
||||||
|
*/
|
||||||
|
async function tryRun(promise) {
|
||||||
|
try {
|
||||||
|
return await promise;
|
||||||
|
}
|
||||||
|
catch (err) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} directory - The directory to find .gitignore and .eslintignore
|
||||||
|
* @returns {Promise<string[]>} - List of ignore glob patterns
|
||||||
|
*/
|
||||||
|
async function getIgnoredFiles(directory) {
|
||||||
|
const gitIgnore = (await tryRun(fs.readFile(join(directory, '.gitignore'), 'utf8')) ?? '')
|
||||||
|
.split('\n')
|
||||||
|
.filter(p => p && !p.startsWith('#'))
|
||||||
|
.map(p => join(directory, '**', p));
|
||||||
|
|
||||||
|
const eslintIgnore = (await tryRun(fs.readFile(join(directory, '.eslintignore'), 'utf8')) ?? '')
|
||||||
|
.split('\n')
|
||||||
|
.filter(p => p && !p.startsWith('#'))
|
||||||
|
.map(p => join(directory, '**', p));
|
||||||
|
|
||||||
|
return [...eslintIgnore, ...gitIgnore];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} directory - The directory to work in.
|
||||||
|
* @returns {Promise<string>} - The package name founded.
|
||||||
|
*/
|
||||||
|
async function getPackageName(directory) {
|
||||||
|
if (existsSync(join(directory, 'package.json'))) {
|
||||||
|
const file = await fs.readFile(join(directory, 'package.json'), 'utf8');
|
||||||
|
/** @type {{name?: string}} */
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
||||||
|
const obj = JSON.parse(file);
|
||||||
|
|
||||||
|
if (obj.name) return obj.name;
|
||||||
|
}
|
||||||
|
return path.normalize(directory).split('/').at(-1) ?? directory;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} directory - The directory path to work on
|
||||||
|
* @param {{files: string[], directories: string[]}} paths - The file list to be filtered
|
||||||
|
* @param {string[]} [packages] - The packages to be filtered
|
||||||
|
* @returns {Promise<import('./types').Package>} - The package object
|
||||||
|
*/
|
||||||
|
async function getRootPackage(directory, paths, packages = []) {
|
||||||
|
|
||||||
|
const ignorePatterns = [
|
||||||
|
...packages.map(p =>
|
||||||
|
`${join(directory, p, '**/*')}`,
|
||||||
|
)];
|
||||||
|
|
||||||
|
return {
|
||||||
|
name: `${await getPackageName(directory)} [ROOT]`,
|
||||||
|
files: paths.files.filter(f =>
|
||||||
|
!glob.isMatch(f, ignorePatterns),
|
||||||
|
) ?? [],
|
||||||
|
directories: paths.directories.filter(d =>
|
||||||
|
!glob.isMatch(d, ignorePatterns),
|
||||||
|
) ?? [],
|
||||||
|
path: directory,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
export default class Workspace {
|
||||||
|
/** @type {{files: string[], directories: string[]} | undefined} */
|
||||||
|
paths;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} directory - The directory to get the workspace from
|
||||||
|
*/
|
||||||
|
constructor(directory) {
|
||||||
|
this.dir = directory;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} [directory] - The directory to work on
|
||||||
|
* @param {string[]} [ignores] - Glob patterns to ignore
|
||||||
|
* @returns {Promise<{files: string[], directories: string[]}>} - List of all files in the directory
|
||||||
|
*/
|
||||||
|
async getPaths(directory = this.dir, ignores = []) {
|
||||||
|
|
||||||
|
ignores.push(
|
||||||
|
...[
|
||||||
|
'.git',
|
||||||
|
'.dist',
|
||||||
|
'.DS_Store',
|
||||||
|
'node_modules',
|
||||||
|
].map((f) => join(directory, f)),
|
||||||
|
...await getIgnoredFiles(directory),
|
||||||
|
);
|
||||||
|
|
||||||
|
const paths = (await fs.readdir(directory))
|
||||||
|
.map((f) => path.normalize(join(directory, f)))
|
||||||
|
.filter((p) => !glob.isMatch(p, ignores));
|
||||||
|
|
||||||
|
/** @type {string[]} */
|
||||||
|
const files = [];
|
||||||
|
/** @type {string[]} */
|
||||||
|
const directories = [];
|
||||||
|
|
||||||
|
for (const path of paths) {
|
||||||
|
if ((await fs.lstat(path)).isDirectory()) {
|
||||||
|
const subPaths = await this.getPaths(path, ignores);
|
||||||
|
directories.push(path, ...subPaths.directories);
|
||||||
|
files.push(...subPaths.files);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
files.push(path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return { files, directories };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @type {string[] | undefined} */
|
||||||
|
packages;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns {Promise<string[]>} - List of packages on a directory;
|
||||||
|
*/
|
||||||
|
async getPackages() {
|
||||||
|
|
||||||
|
/** @type {string[]} */
|
||||||
|
let packages = [];
|
||||||
|
|
||||||
|
const pnpmWorkspace =
|
||||||
|
existsSync(join(this.dir, 'pnpm-workspace.yaml'))
|
||||||
|
? 'pnpm-workspace.yaml'
|
||||||
|
: existsSync(join(this.dir, 'pnpm-workspace.yml'))
|
||||||
|
? 'pnpm-workspace.yml'
|
||||||
|
: null;
|
||||||
|
|
||||||
|
if (pnpmWorkspace) {
|
||||||
|
const fileYaml = await fs.readFile(join(this.dir, pnpmWorkspace), 'utf8');
|
||||||
|
|
||||||
|
/** @type {{packages?: string[]}} */
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
||||||
|
const fileObj = YAML.parse(fileYaml);
|
||||||
|
|
||||||
|
packages.push(...(fileObj?.packages ?? []));
|
||||||
|
}
|
||||||
|
else if (existsSync(join(this.dir, 'package.json'))) {
|
||||||
|
const packageJson = await fs.readFile(join(this.dir, 'package.json'), 'utf8');
|
||||||
|
|
||||||
|
/** @type {{workspaces?: string[]}} */
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
|
||||||
|
const packageObj = JSON.parse(packageJson);
|
||||||
|
|
||||||
|
packages.push(...(packageObj?.workspaces ?? []));
|
||||||
|
}
|
||||||
|
return packages;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @type {import('./types').Workspace | undefined} */
|
||||||
|
workspace;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns {Promise<import('./types').Workspace>}
|
||||||
|
* The workspace structure and packages founded
|
||||||
|
*/
|
||||||
|
async getWorkspace() {
|
||||||
|
console.log(this.packages);
|
||||||
|
const rootPackage = await getRootPackage(this.dir, this.paths ?? { files: [], directories: [] }, this.packages);
|
||||||
|
|
||||||
|
/** @type {string[]} */
|
||||||
|
const packagesPaths = this.paths?.directories.filter(d =>
|
||||||
|
glob.isMatch(d, this.packages?.map(p => join(this.dir, p)) ?? ''),
|
||||||
|
) ?? [];
|
||||||
|
|
||||||
|
/** @type {import('./types').Package[]} */
|
||||||
|
const packages = [];
|
||||||
|
|
||||||
|
for (const pkgPath of packagesPaths) {
|
||||||
|
packages.push({
|
||||||
|
name: await getPackageName(pkgPath),
|
||||||
|
files: this.paths?.files.filter(f => glob.isMatch(f, join(pkgPath, '**/*'))) ?? [],
|
||||||
|
directories: this.paths?.directories.filter(f => glob.isMatch(f, join(pkgPath, '**/*'))) ?? [],
|
||||||
|
path: pkgPath,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
packages: [
|
||||||
|
rootPackage,
|
||||||
|
...packages,
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async get() {
|
||||||
|
this.packages ||= await this.getPackages();
|
||||||
|
this.paths = await this.getPaths();
|
||||||
|
this.workspace = await this.getWorkspace();
|
||||||
|
|
||||||
|
return this.workspace;
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user