Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 | import { getProjects, joinPathFragments, logger, type ProjectConfiguration, type Tree } from '@nx/devkit';
import { execFileSync } from 'child_process';
import { directoryExists } from 'nx/src/utils/fileutils';
import type { ISchematicContext } from './schema.interface';
import { findFiles } from './utils/find-files.util';
type TModuleBoundaryConfig = Array<{
sourceTag: string;
onlyDependOnLibsWithTags: string[];
}>;
interface IAuditException {
file: string;
message: string;
sourceRoot: string;
}
/**
* Reads the boundaries file.
* @param configDir the directory with .eslint configuration files
* @param verbose whether to print detailed output
*/
const depConstraints = (configDir: string, verbose?: boolean) => {
const configExists = directoryExists(configDir);
if (!configExists) {
throw new Error(`The directory with the module boundary configurations does not exist: ${configDir}.`);
}
if (verbose === true) {
logger.log('configDir', configDir);
}
const configFiles = findFiles(configDir, '.mjs');
if (verbose === true) {
logger.log('configFiles', configFiles);
}
const files = configFiles.stdout.length > 0 ? configFiles.stdout.split(' ') : [];
const configs = files.map(file => {
const config: {
file: string;
constraints: TModuleBoundaryConfig;
} = {
file,
constraints: [],
};
let json: {
constraints: TModuleBoundaryConfig;
};
try {
json = require(file);
const constraints = json.constraints;
config.constraints = [...constraints];
return config;
} catch (e) {
throw e as Error;
}
});
return configs;
};
/**
* Get project source roots.
* @param tree the file system tree
* @param entries project configurations
* @param constraints the module bounary constraints
* @param verbose whether to print detailed output
*/
const projectSourceRoots = (
tree: Tree,
entries: ProjectConfiguration[],
constraints: Array<{
file: string;
constraints: TModuleBoundaryConfig;
}>,
verbose?: boolean,
) => {
const scopes = constraints.reduce((accumulator: string[], item) => {
const result = item.constraints.map(constraint => constraint.sourceTag);
accumulator.push(...result);
return accumulator;
}, []);
if (verbose === true) {
logger.log('scopes with constraints', scopes);
}
const projects = scopes.reduce((accumulator: ProjectConfiguration[], scope) => {
const result = entries.find(entry => (entry.tags ?? []).includes(scope));
if (typeof result !== 'undefined') {
accumulator.push(result);
}
return accumulator;
}, []);
if (verbose === true) {
logger.log('projects with constraints', projects);
}
const allBoundaryConfigs = constraints.reduce((accumulator: Array<TModuleBoundaryConfig['0'] & { file: string }>, item) => {
const result = item.constraints.map(record => ({
...record,
file: item.file,
}));
accumulator.push(...result);
return accumulator;
}, []);
if (verbose === true) {
logger.log('all boundary configs', allBoundaryConfigs);
}
const sourceRoots = projects
.map(project => ({
scope: project.tags?.find(tag => tag.includes('scope')) ?? ('' as string),
sourceRoot: project.sourceRoot ?? '',
}))
.filter(record => record.scope !== '' && record.sourceRoot !== '')
.map(record => {
const boundaryConfig = allBoundaryConfigs.find(config => config.sourceTag === record.scope);
const result = {
...record,
sourceRoot: `${tree.root}/${record.sourceRoot}`,
dependsOnTags: boundaryConfig?.onlyDependOnLibsWithTags ?? [],
file: boundaryConfig?.file ?? '',
};
return result;
});
if (verbose === true) {
logger.log('project source roots', sourceRoots);
}
return sourceRoots;
};
export default async function (tree: Tree, schema: ISchematicContext) {
const projects = getProjects(tree);
const entries = [...projects.values()];
const configDir = schema.configDir ?? joinPathFragments(tree.root, '.eslint');
const constraints = depConstraints(configDir);
if (schema.verbose === true) {
logger.log('constraints', constraints);
}
const sourceRoots = projectSourceRoots(tree, entries, constraints, schema.verbose);
const exceptions: IAuditException[] = [];
for (let i = 0, max = sourceRoots.length; i < max; i += 1) {
const config = sourceRoots.at(i);
if (typeof config !== 'undefined') {
const src = config.sourceRoot;
const tags = config.dependsOnTags;
for (let j = 0, maxJ = tags.length; j < maxJ; j += 1) {
const tag = tags[j];
const partialImportPath = tag.replace('scope:', '');
const cmd = 'find';
const args = [src, '-type', 'f', '-name', '"*.ts"', '|', 'xargs', 'grep', `"${partialImportPath}"`, '--color=always'];
try {
execFileSync(cmd, args, { stdio: 'inherit', cwd: process.cwd(), env: process.env, shell: true });
} catch {
const exception = {
file: config.file,
message: `The scope '${config.scope}' does not depend on the tag '${tag}'.`,
sourceRoot: config.sourceRoot,
};
if (schema.verbose === true) {
logger.error(exception.message);
}
exceptions.push(exception);
}
}
}
}
logger.log('\nAll exceptions:');
for (let i = 0, max = exceptions.length; i < max; i += 1) {
const exception = exceptions.at(i);
if (typeof exception !== 'undefined') {
logger.error(`ℹ ${exception.message}`);
logger.info(` Source: ${exception.sourceRoot}`);
logger.info(` File: ${exception.file}`);
}
}
return () => ({ success: true });
}
|