Skip to content

Commit

Permalink
chore(progress): updates copy
Browse files Browse the repository at this point in the history
  • Loading branch information
sverweij committed Jan 21, 2025
1 parent f82135e commit ff8aa28
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 29 deletions.
2 changes: 1 addition & 1 deletion src/cache/cache.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export default class Cache {
},
));
this.#revisionData.cacheFormatVersion = CACHE_FORMAT_VERSION;
bus.debug("cache: - comparing");
bus.debug("cache: - compare");
return (
this.cacheFormatVersionCompatible(pCachedCruiseResult) &&
this.#cacheStrategy.revisionDataEqual(
Expand Down
8 changes: 4 additions & 4 deletions src/cache/find-content-changes.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export default function findContentChanges(
pCachedCruiseResult,
pOptions,
) {
bus.debug("cache: - getting revision data");
bus.debug("cache: - get revision data");
const lFileSet = new Set(
findAllFiles(pDirectory, {
baseDir: pOptions.baseDir,
Expand All @@ -91,12 +91,12 @@ export default function findContentChanges(
}).filter(hasInterestingExtension(pOptions.extensions)),
);

bus.debug("cache: - getting (cached - new)");
bus.debug("cache: - get (cached - new)");
const lDiffCachedVsNew = pCachedCruiseResult.modules.map(
diffCachedModuleAgainstFileSet(lFileSet, pOptions.baseDir),
);

bus.debug("cache: - getting (new - cached)");
bus.debug("cache: - get (new - cached)");
lDiffCachedVsNew.forEach(({ name }) => lFileSet.delete(name));

const lDiffNewVsCached = [];
Expand All @@ -108,6 +108,6 @@ export default function findContentChanges(
});
}

bus.debug("cache: - returning revision data");
bus.debug("cache: - return revision data");
return lDiffCachedVsNew.concat(lDiffNewVsCached);
}
6 changes: 3 additions & 3 deletions src/cache/metadata-strategy.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ export default class MetaDataStrategy {
...pOptions,
};
try {
bus.debug("cache: - getting sha");
bus.debug("cache: - get sha");
const lSHA = await lOptions.shaRetrievalFn();
bus.debug("cache: - getting diff");
bus.debug("cache: - get diff");
const lDiff = /** @type {IChange[]} */ (
await lOptions.diffListFn({ oldRevision: lSHA })
);
Expand All @@ -55,7 +55,7 @@ export default class MetaDataStrategy {
)
.filter(changeHasInterestingExtension(lOptions.extensions))
.filter(isInterestingChangeType(lOptions.interestingChangeTypes));
bus.debug("cache: - sha-summing diff");
bus.debug("cache: - sha-sum diff");
return {
SHA1: lSHA,
changes: lChanges.map(lOptions.checksumFn),
Expand Down
14 changes: 7 additions & 7 deletions src/enrich/enrich-modules.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,29 @@ import { bus } from "#utl/bus.mjs";
* @returns {IModule[]}
*/
export default function enrichModules(pModules, pOptions) {
bus.info("analyzing: cycles");
bus.info("analyze: cycles");
const lIndexedModules = new IndexedModuleGraph(pModules);
let lModules = deriveCycles(pModules, lIndexedModules, {
pSourceAttribute: "source",
pDependencyName: "resolved",
pSkipAnalysisNotInRules: pOptions.skipAnalysisNotInRules,
pRuleSet: pOptions.ruleSet,
});
bus.info("analyzing: dependents");
bus.info("analyze: dependents");
lModules = addDependents(lModules, pOptions);
bus.info("analyzing: orphans");
bus.info("analyze: orphans");
lModules = deriveOrphans(lModules, pOptions);
bus.info("analyzing: reachables");
bus.info("analyze: reachables");
lModules = deriveReachable(lModules, pOptions.ruleSet);
bus.info("analyzing: module metrics");
bus.info("analyze: module metrics");
lModules = deriveModuleMetrics(lModules, pOptions);
bus.info("analyzing: focus");
bus.info("analyze: focus");
lModules = addFocus(lModules, pOptions.focus);

// when validate === false we might want to skip the addValidations.
// We don't at this time, however, as "valid" is a mandatory
// attribute (to simplify reporter logic)
bus.info("analyzing: validations");
bus.info("analyze: validations");
lModules = addValidations(lModules, pOptions.ruleSet, pOptions.validate);

lModules = softenKnownViolations(lModules, pOptions.knownViolations);
Expand Down
5 changes: 4 additions & 1 deletion src/enrich/index.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import enrichModules from "./enrich-modules.mjs";
import aggregateToFolders from "./derive/folders/index.mjs";
import summarize from "./summarize/index.mjs";
import { bus } from "#utl/bus.mjs";

/**
* Enriches the passed modules with things like cycle detection, validations,
Expand All @@ -17,16 +18,18 @@ import summarize from "./summarize/index.mjs";
*/
export default function enrich(pModules, pOptions, pFileAndDirectoryArray) {
const lModules = enrichModules(pModules, pOptions);
bus.info("analyze: aggregate to folders");
const lFolders = aggregateToFolders(lModules, pOptions);

bus.info("analyze: summary");
const lReturnValue = {
modules: lModules,
...lFolders,
summary: summarize(
lModules,
pOptions,
pFileAndDirectoryArray,
lFolders.folders
lFolders.folders,
),
};

Expand Down
2 changes: 1 addition & 1 deletion src/enrich/soften-known-violations.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ export default function softenKnownViolations(
pSoftenedSeverity = "ignore",
) {
if (pKnownViolations) {
bus.info("analyzing: comparing against known errors");
bus.info("analyze: compare to known errors");
return pModules.map((pModule) =>
softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity),
);
Expand Down
4 changes: 2 additions & 2 deletions src/extract/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,13 @@ function extractFileDirectoryArray(
) {
let lVisited = new Set();

bus.info("reading files: gathering initial sources");
bus.info("read files: gather initial sources");
const lInitialSources = gatherInitialSources(
pFileDirectoryArray,
pCruiseOptions,
);

bus.info("reading files: visiting dependencies");
bus.info("read files: visit dependencies");
return lInitialSources.reduce((pDependencies, pFilename) => {
if (!lVisited.has(pFilename)) {
lVisited.add(pFilename);
Expand Down
20 changes: 10 additions & 10 deletions src/main/cruise.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default async function cruise(
pResolveOptions,
pTranspileOptions,
) {
bus.summary("parsing options", c(1));
bus.summary("parse options", c(1));
const lCruiseOptionsValid = assertCruiseOptionsValid(pCruiseOptions);
/** @type {import("../../types/strict-options.js").IStrictCruiseOptions} */
let lCruiseOptions = normalizeCruiseOptions(
Expand All @@ -29,7 +29,7 @@ export default async function cruise(

if (lCruiseOptions.cache) {
bus.summary(
`cache: checking freshness with ${lCruiseOptions.cache.strategy}`,
`cache: check freshness with ${lCruiseOptions.cache.strategy}`,
c(2),
);

Expand All @@ -41,12 +41,12 @@ export default async function cruise(
const lCachedResults = await lCache.read(lCruiseOptions.cache.folder);

if (await lCache.canServeFromCache(lCruiseOptions, lCachedResults)) {
bus.summary("cache: reporting from cache", c(8));
bus.summary("cache: report from cache", c(8));
return await reportWrap(lCachedResults, lCruiseOptions);
}
}

bus.summary("importing analytical modules", c(3));
bus.summary("import analytical modules", c(3));
const [
{ default: normalizeRuleSet },
{ default: assertRuleSetValid },
Expand All @@ -66,7 +66,7 @@ export default async function cruise(
]);

if (lCruiseOptions.ruleSet) {
bus.summary("parsing rule set", c(4));
bus.summary("parse rule set", c(4));
lCruiseOptions.ruleSet = normalizeRuleSet(
assertRuleSetValid(lCruiseOptions.ruleSet),
);
Expand All @@ -76,33 +76,33 @@ export default async function cruise(
pFileAndDirectoryArray,
);

bus.summary("determining how to resolve", c(5));
bus.summary("determine how to resolve", c(5));
const lNormalizedResolveOptions = await normalizeResolveOptions(
pResolveOptions,
lCruiseOptions,
pTranspileOptions?.tsConfig,
);

bus.summary("reading files", c(6));
bus.summary("read files", c(6));
const lExtractionResult = extract(
lNormalizedFileAndDirectoryArray,
lCruiseOptions,
lNormalizedResolveOptions,
pTranspileOptions,
);

bus.summary("analyzing", c(7));
bus.summary("analyze", c(7));
const lCruiseResult = enrich(
lExtractionResult,
lCruiseOptions,
lNormalizedFileAndDirectoryArray,
);

if (lCruiseOptions.cache) {
bus.summary("cache: saving", c(8));
bus.summary("cache: save", c(8));
await lCache.write(lCruiseOptions.cache.folder, lCruiseResult);
}

bus.summary("reporting", c(9));
bus.summary("report", c(9));
return await reportWrap(lCruiseResult, lCruiseOptions);
}

0 comments on commit ff8aa28

Please sign in to comment.