From 3f32dacfec692d0b70b4baa0afdb3334bd05e357 Mon Sep 17 00:00:00 2001 From: Elliot Winkler Date: Wed, 10 Jul 2024 14:15:17 -0600 Subject: [PATCH] Update report output format (#90) This commit simply aligns the output so that all of the icons that mark whether a rule passed, failed, or errored are on the left hand side. This makes the output prettier and makes it easier to tell what the status of a rule is. This commit also eschews emoji (which pop out too much) for other kinds of characters. --- src/main.test.ts | 956 ++++++++++++------------- src/report-project-lint-result.test.ts | 14 +- src/report-project-lint-result.ts | 29 +- 3 files changed, 506 insertions(+), 493 deletions(-) diff --git a/src/main.test.ts b/src/main.test.ts index aa48eb9..d3f67cb 100644 --- a/src/main.test.ts +++ b/src/main.test.ts @@ -198,46 +198,46 @@ describe('main', () => { repo-1 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ✅ -- Does the \`packageManager\` field in \`package.json\` conform? ✅ -- Does the \`engines.node\` field in \`package.json\` conform? ✅ -- Do the lint-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the jest-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the test-related \`scripts\` in \`package.json\` conform? ✅ -- Do the typescript-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the typescript-related \`scripts\` in \`package.json\` conform? ✅ -- Does the \`exports\` field in \`package.json\` conform? ✅ -- Does the \`main\` field in \`package.json\` conform? ✅ -- Does the \`module\` field in \`package.json\` conform? ✅ -- Does the \`types\` field in \`package.json\` conform? ✅ -- Does the \`files\` field in \`package.json\` conform? ✅ -- Does LavaMoat allow scripts for \`tsup>esbuild\`? ✅ -- Do the typedoc-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the typedoc-related \`scripts\` in \`package.json\` conform? ✅ -- Do the changelog-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the changelog-related \`scripts\` in \`package.json\` conform? ✅ -- Do the lavamoat-related \`devDependencies\` in \`package.json\` conform? ✅ -- Are postinstall scripts disabled for \`@lavamoat/preinstall-always-fail\`? ✅ -- Is \`README.md\` present? ✅ -- Does the README conform by recommending the correct Yarn version to install? ✅ -- Does the README conform by recommending node install from nodejs.org? ✅ -- Are all of the files for Yarn Modern present, and do they conform? ✅ -- Does the README conform by recommending the correct Yarn version to install? ✅ -- Does allow scripts conforms to yarn? ✅ -- Is the allow-scripts Yarn plugin installed? ✅ -- Does the \`src/\` directory exist? ✅ -- Is \`.nvmrc\` present, and does it conform? ✅ -- Is \`jest.config.js\` present, and does it conform? ✅ -- Is \`tsconfig.json\` present, and does it conform? ✅ -- Is \`tsconfig.build.json\` present, and does it conform? ✅ -- Is \`tsup.config.ts\` present, and does it conform? ✅ -- Is \`typedoc.json\` present, and does it conform? ✅ -- Is \`CHANGELOG.md\` present? ✅ -- Is \`CHANGELOG.md\` well-formatted? ✅ -- Is \`.editorconfig\` present, and does it conform? ✅ -- Is \`.gitattributes\` present, and does it conform? ✅ -- Is \`.gitignore\` present, and does it conform? ✅ +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✔︎] Does the package have a well-formed manifest (\`package.json\`)? +[✔︎] Does the \`packageManager\` field in \`package.json\` conform? +[✔︎] Does the \`engines.node\` field in \`package.json\` conform? +[✔︎] Do the lint-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the jest-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the test-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the typescript-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the typescript-related \`scripts\` in \`package.json\` conform? +[✔︎] Does the \`exports\` field in \`package.json\` conform? +[✔︎] Does the \`main\` field in \`package.json\` conform? +[✔︎] Does the \`module\` field in \`package.json\` conform? +[✔︎] Does the \`types\` field in \`package.json\` conform? +[✔︎] Does the \`files\` field in \`package.json\` conform? +[✔︎] Does LavaMoat allow scripts for \`tsup>esbuild\`? +[✔︎] Do the typedoc-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the typedoc-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the changelog-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the changelog-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the lavamoat-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Are postinstall scripts disabled for \`@lavamoat/preinstall-always-fail\`? +[✔︎] Is \`README.md\` present? +[✔︎] Does the README conform by recommending the correct Yarn version to install? +[✔︎] Does the README conform by recommending node install from nodejs.org? +[✔︎] Are all of the files for Yarn Modern present, and do they conform? +[✔︎] Does the README conform by recommending the correct Yarn version to install? +[✔︎] Does allow scripts conforms to yarn? +[✔︎] Is the allow-scripts Yarn plugin installed? +[✔︎] Does the \`src/\` directory exist? +[✔︎] Is \`.nvmrc\` present, and does it conform? +[✔︎] Is \`jest.config.js\` present, and does it conform? +[✔︎] Is \`tsconfig.json\` present, and does it conform? +[✔︎] Is \`tsconfig.build.json\` present, and does it conform? +[✔︎] Is \`tsup.config.ts\` present, and does it conform? +[✔︎] Is \`typedoc.json\` present, and does it conform? +[✔︎] Is \`CHANGELOG.md\` present? +[✔︎] Is \`CHANGELOG.md\` well-formatted? +[✔︎] Is \`.editorconfig\` present, and does it conform? +[✔︎] Is \`.gitattributes\` present, and does it conform? +[✔︎] Is \`.gitignore\` present, and does it conform? Results: 40 passed, 0 failed, 0 errored, 40 total Elapsed time: 0 ms @@ -246,46 +246,46 @@ Elapsed time: 0 ms repo-2 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ✅ -- Does the \`packageManager\` field in \`package.json\` conform? ✅ -- Does the \`engines.node\` field in \`package.json\` conform? ✅ -- Do the lint-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the jest-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the test-related \`scripts\` in \`package.json\` conform? ✅ -- Do the typescript-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the typescript-related \`scripts\` in \`package.json\` conform? ✅ -- Does the \`exports\` field in \`package.json\` conform? ✅ -- Does the \`main\` field in \`package.json\` conform? ✅ -- Does the \`module\` field in \`package.json\` conform? ✅ -- Does the \`types\` field in \`package.json\` conform? ✅ -- Does the \`files\` field in \`package.json\` conform? ✅ -- Does LavaMoat allow scripts for \`tsup>esbuild\`? ✅ -- Do the typedoc-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the typedoc-related \`scripts\` in \`package.json\` conform? ✅ -- Do the changelog-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the changelog-related \`scripts\` in \`package.json\` conform? ✅ -- Do the lavamoat-related \`devDependencies\` in \`package.json\` conform? ✅ -- Are postinstall scripts disabled for \`@lavamoat/preinstall-always-fail\`? ✅ -- Is \`README.md\` present? ✅ -- Does the README conform by recommending the correct Yarn version to install? ✅ -- Does the README conform by recommending node install from nodejs.org? ✅ -- Are all of the files for Yarn Modern present, and do they conform? ✅ -- Does the README conform by recommending the correct Yarn version to install? ✅ -- Does allow scripts conforms to yarn? ✅ -- Is the allow-scripts Yarn plugin installed? ✅ -- Does the \`src/\` directory exist? ✅ -- Is \`.nvmrc\` present, and does it conform? ✅ -- Is \`jest.config.js\` present, and does it conform? ✅ -- Is \`tsconfig.json\` present, and does it conform? ✅ -- Is \`tsconfig.build.json\` present, and does it conform? ✅ -- Is \`tsup.config.ts\` present, and does it conform? ✅ -- Is \`typedoc.json\` present, and does it conform? ✅ -- Is \`CHANGELOG.md\` present? ✅ -- Is \`CHANGELOG.md\` well-formatted? ✅ -- Is \`.editorconfig\` present, and does it conform? ✅ -- Is \`.gitattributes\` present, and does it conform? ✅ -- Is \`.gitignore\` present, and does it conform? ✅ +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✔︎] Does the package have a well-formed manifest (\`package.json\`)? +[✔︎] Does the \`packageManager\` field in \`package.json\` conform? +[✔︎] Does the \`engines.node\` field in \`package.json\` conform? +[✔︎] Do the lint-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the jest-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the test-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the typescript-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the typescript-related \`scripts\` in \`package.json\` conform? +[✔︎] Does the \`exports\` field in \`package.json\` conform? +[✔︎] Does the \`main\` field in \`package.json\` conform? +[✔︎] Does the \`module\` field in \`package.json\` conform? +[✔︎] Does the \`types\` field in \`package.json\` conform? +[✔︎] Does the \`files\` field in \`package.json\` conform? +[✔︎] Does LavaMoat allow scripts for \`tsup>esbuild\`? +[✔︎] Do the typedoc-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the typedoc-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the changelog-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the changelog-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the lavamoat-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Are postinstall scripts disabled for \`@lavamoat/preinstall-always-fail\`? +[✔︎] Is \`README.md\` present? +[✔︎] Does the README conform by recommending the correct Yarn version to install? +[✔︎] Does the README conform by recommending node install from nodejs.org? +[✔︎] Are all of the files for Yarn Modern present, and do they conform? +[✔︎] Does the README conform by recommending the correct Yarn version to install? +[✔︎] Does allow scripts conforms to yarn? +[✔︎] Is the allow-scripts Yarn plugin installed? +[✔︎] Does the \`src/\` directory exist? +[✔︎] Is \`.nvmrc\` present, and does it conform? +[✔︎] Is \`jest.config.js\` present, and does it conform? +[✔︎] Is \`tsconfig.json\` present, and does it conform? +[✔︎] Is \`tsconfig.build.json\` present, and does it conform? +[✔︎] Is \`tsup.config.ts\` present, and does it conform? +[✔︎] Is \`typedoc.json\` present, and does it conform? +[✔︎] Is \`CHANGELOG.md\` present? +[✔︎] Is \`CHANGELOG.md\` well-formatted? +[✔︎] Is \`.editorconfig\` present, and does it conform? +[✔︎] Is \`.gitattributes\` present, and does it conform? +[✔︎] Is \`.gitignore\` present, and does it conform? Results: 40 passed, 0 failed, 0 errored, 40 total Elapsed time: 0 ms @@ -333,38 +333,38 @@ Elapsed time: 0 ms repo-1 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ❌ - - The config file for Yarn Classic, \`.yarnrc\`, is present. Please upgrade this project to Yarn Modern. -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ❌ - - \`CHANGELOG.md\` does not exist in this project. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✘] Is the classic Yarn config file (\`.yarnrc\`) absent? + - The config file for Yarn Classic, \`.yarnrc\`, is present. Please upgrade this project to Yarn Modern. +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✘] Is \`CHANGELOG.md\` present? + - \`CHANGELOG.md\` does not exist in this project. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 0 passed, 15 failed, 0 errored, 15 total Elapsed time: 0 ms @@ -373,38 +373,38 @@ Elapsed time: 0 ms repo-2 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ❌ - - The config file for Yarn Classic, \`.yarnrc\`, is present. Please upgrade this project to Yarn Modern. -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ❌ - - \`CHANGELOG.md\` does not exist in this project. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✘] Is the classic Yarn config file (\`.yarnrc\`) absent? + - The config file for Yarn Classic, \`.yarnrc\`, is present. Please upgrade this project to Yarn Modern. +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✘] Is \`CHANGELOG.md\` present? + - \`CHANGELOG.md\` does not exist in this project. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 0 passed, 15 failed, 0 errored, 15 total Elapsed time: 0 ms @@ -455,38 +455,38 @@ Elapsed time: 0 ms repo-1 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ✅ -- Is \`CHANGELOG.md\` well-formatted? ⚠️ - - ERROR: Encountered an error validating the changelog: Could not read JSON file '${sandboxDirectoryPath}/repositories/repo-1/package.json'. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✔︎] Is \`CHANGELOG.md\` present? +[?] Is \`CHANGELOG.md\` well-formatted? + - ERROR: Encountered an error validating the changelog: Could not read JSON file '${sandboxDirectoryPath}/repositories/repo-1/package.json'. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 2 passed, 13 failed, 1 errored, 16 total Elapsed time: 0 ms @@ -495,38 +495,38 @@ Elapsed time: 0 ms repo-2 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ✅ -- Is \`CHANGELOG.md\` well-formatted? ⚠️ - - ERROR: Encountered an error validating the changelog: Could not read JSON file '${sandboxDirectoryPath}/repositories/repo-2/package.json'. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✔︎] Is \`CHANGELOG.md\` present? +[?] Is \`CHANGELOG.md\` well-formatted? + - ERROR: Encountered an error validating the changelog: Could not read JSON file '${sandboxDirectoryPath}/repositories/repo-2/package.json'. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 2 passed, 13 failed, 1 errored, 16 total Elapsed time: 0 ms @@ -581,37 +581,37 @@ Cloning repository MetaMask/repo-2, please wait... repo-2 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ❌ - - \`CHANGELOG.md\` does not exist in this project. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✘] Is \`CHANGELOG.md\` present? + - \`CHANGELOG.md\` does not exist in this project. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 1 passed, 14 failed, 0 errored, 15 total Elapsed time: 0 ms @@ -780,46 +780,46 @@ Elapsed time: 0 ms repo-1 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ✅ -- Does the \`packageManager\` field in \`package.json\` conform? ✅ -- Does the \`engines.node\` field in \`package.json\` conform? ✅ -- Do the lint-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the jest-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the test-related \`scripts\` in \`package.json\` conform? ✅ -- Do the typescript-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the typescript-related \`scripts\` in \`package.json\` conform? ✅ -- Does the \`exports\` field in \`package.json\` conform? ✅ -- Does the \`main\` field in \`package.json\` conform? ✅ -- Does the \`module\` field in \`package.json\` conform? ✅ -- Does the \`types\` field in \`package.json\` conform? ✅ -- Does the \`files\` field in \`package.json\` conform? ✅ -- Does LavaMoat allow scripts for \`tsup>esbuild\`? ✅ -- Do the typedoc-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the typedoc-related \`scripts\` in \`package.json\` conform? ✅ -- Do the changelog-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the changelog-related \`scripts\` in \`package.json\` conform? ✅ -- Do the lavamoat-related \`devDependencies\` in \`package.json\` conform? ✅ -- Are postinstall scripts disabled for \`@lavamoat/preinstall-always-fail\`? ✅ -- Is \`README.md\` present? ✅ -- Does the README conform by recommending the correct Yarn version to install? ✅ -- Does the README conform by recommending node install from nodejs.org? ✅ -- Are all of the files for Yarn Modern present, and do they conform? ✅ -- Does the README conform by recommending the correct Yarn version to install? ✅ -- Does allow scripts conforms to yarn? ✅ -- Is the allow-scripts Yarn plugin installed? ✅ -- Does the \`src/\` directory exist? ✅ -- Is \`.nvmrc\` present, and does it conform? ✅ -- Is \`jest.config.js\` present, and does it conform? ✅ -- Is \`tsconfig.json\` present, and does it conform? ✅ -- Is \`tsconfig.build.json\` present, and does it conform? ✅ -- Is \`tsup.config.ts\` present, and does it conform? ✅ -- Is \`typedoc.json\` present, and does it conform? ✅ -- Is \`CHANGELOG.md\` present? ✅ -- Is \`CHANGELOG.md\` well-formatted? ✅ -- Is \`.editorconfig\` present, and does it conform? ✅ -- Is \`.gitattributes\` present, and does it conform? ✅ -- Is \`.gitignore\` present, and does it conform? ✅ +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✔︎] Does the package have a well-formed manifest (\`package.json\`)? +[✔︎] Does the \`packageManager\` field in \`package.json\` conform? +[✔︎] Does the \`engines.node\` field in \`package.json\` conform? +[✔︎] Do the lint-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the jest-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the test-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the typescript-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the typescript-related \`scripts\` in \`package.json\` conform? +[✔︎] Does the \`exports\` field in \`package.json\` conform? +[✔︎] Does the \`main\` field in \`package.json\` conform? +[✔︎] Does the \`module\` field in \`package.json\` conform? +[✔︎] Does the \`types\` field in \`package.json\` conform? +[✔︎] Does the \`files\` field in \`package.json\` conform? +[✔︎] Does LavaMoat allow scripts for \`tsup>esbuild\`? +[✔︎] Do the typedoc-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the typedoc-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the changelog-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the changelog-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the lavamoat-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Are postinstall scripts disabled for \`@lavamoat/preinstall-always-fail\`? +[✔︎] Is \`README.md\` present? +[✔︎] Does the README conform by recommending the correct Yarn version to install? +[✔︎] Does the README conform by recommending node install from nodejs.org? +[✔︎] Are all of the files for Yarn Modern present, and do they conform? +[✔︎] Does the README conform by recommending the correct Yarn version to install? +[✔︎] Does allow scripts conforms to yarn? +[✔︎] Is the allow-scripts Yarn plugin installed? +[✔︎] Does the \`src/\` directory exist? +[✔︎] Is \`.nvmrc\` present, and does it conform? +[✔︎] Is \`jest.config.js\` present, and does it conform? +[✔︎] Is \`tsconfig.json\` present, and does it conform? +[✔︎] Is \`tsconfig.build.json\` present, and does it conform? +[✔︎] Is \`tsup.config.ts\` present, and does it conform? +[✔︎] Is \`typedoc.json\` present, and does it conform? +[✔︎] Is \`CHANGELOG.md\` present? +[✔︎] Is \`CHANGELOG.md\` well-formatted? +[✔︎] Is \`.editorconfig\` present, and does it conform? +[✔︎] Is \`.gitattributes\` present, and does it conform? +[✔︎] Is \`.gitignore\` present, and does it conform? Results: 40 passed, 0 failed, 0 errored, 40 total Elapsed time: 0 ms @@ -828,46 +828,46 @@ Elapsed time: 0 ms repo-2 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ✅ -- Does the \`packageManager\` field in \`package.json\` conform? ✅ -- Does the \`engines.node\` field in \`package.json\` conform? ✅ -- Do the lint-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the jest-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the test-related \`scripts\` in \`package.json\` conform? ✅ -- Do the typescript-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the typescript-related \`scripts\` in \`package.json\` conform? ✅ -- Does the \`exports\` field in \`package.json\` conform? ✅ -- Does the \`main\` field in \`package.json\` conform? ✅ -- Does the \`module\` field in \`package.json\` conform? ✅ -- Does the \`types\` field in \`package.json\` conform? ✅ -- Does the \`files\` field in \`package.json\` conform? ✅ -- Does LavaMoat allow scripts for \`tsup>esbuild\`? ✅ -- Do the typedoc-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the typedoc-related \`scripts\` in \`package.json\` conform? ✅ -- Do the changelog-related \`devDependencies\` in \`package.json\` conform? ✅ -- Do the changelog-related \`scripts\` in \`package.json\` conform? ✅ -- Do the lavamoat-related \`devDependencies\` in \`package.json\` conform? ✅ -- Are postinstall scripts disabled for \`@lavamoat/preinstall-always-fail\`? ✅ -- Is \`README.md\` present? ✅ -- Does the README conform by recommending the correct Yarn version to install? ✅ -- Does the README conform by recommending node install from nodejs.org? ✅ -- Are all of the files for Yarn Modern present, and do they conform? ✅ -- Does the README conform by recommending the correct Yarn version to install? ✅ -- Does allow scripts conforms to yarn? ✅ -- Is the allow-scripts Yarn plugin installed? ✅ -- Does the \`src/\` directory exist? ✅ -- Is \`.nvmrc\` present, and does it conform? ✅ -- Is \`jest.config.js\` present, and does it conform? ✅ -- Is \`tsconfig.json\` present, and does it conform? ✅ -- Is \`tsconfig.build.json\` present, and does it conform? ✅ -- Is \`tsup.config.ts\` present, and does it conform? ✅ -- Is \`typedoc.json\` present, and does it conform? ✅ -- Is \`CHANGELOG.md\` present? ✅ -- Is \`CHANGELOG.md\` well-formatted? ✅ -- Is \`.editorconfig\` present, and does it conform? ✅ -- Is \`.gitattributes\` present, and does it conform? ✅ -- Is \`.gitignore\` present, and does it conform? ✅ +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✔︎] Does the package have a well-formed manifest (\`package.json\`)? +[✔︎] Does the \`packageManager\` field in \`package.json\` conform? +[✔︎] Does the \`engines.node\` field in \`package.json\` conform? +[✔︎] Do the lint-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the jest-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the test-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the typescript-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the typescript-related \`scripts\` in \`package.json\` conform? +[✔︎] Does the \`exports\` field in \`package.json\` conform? +[✔︎] Does the \`main\` field in \`package.json\` conform? +[✔︎] Does the \`module\` field in \`package.json\` conform? +[✔︎] Does the \`types\` field in \`package.json\` conform? +[✔︎] Does the \`files\` field in \`package.json\` conform? +[✔︎] Does LavaMoat allow scripts for \`tsup>esbuild\`? +[✔︎] Do the typedoc-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the typedoc-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the changelog-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Do the changelog-related \`scripts\` in \`package.json\` conform? +[✔︎] Do the lavamoat-related \`devDependencies\` in \`package.json\` conform? +[✔︎] Are postinstall scripts disabled for \`@lavamoat/preinstall-always-fail\`? +[✔︎] Is \`README.md\` present? +[✔︎] Does the README conform by recommending the correct Yarn version to install? +[✔︎] Does the README conform by recommending node install from nodejs.org? +[✔︎] Are all of the files for Yarn Modern present, and do they conform? +[✔︎] Does the README conform by recommending the correct Yarn version to install? +[✔︎] Does allow scripts conforms to yarn? +[✔︎] Is the allow-scripts Yarn plugin installed? +[✔︎] Does the \`src/\` directory exist? +[✔︎] Is \`.nvmrc\` present, and does it conform? +[✔︎] Is \`jest.config.js\` present, and does it conform? +[✔︎] Is \`tsconfig.json\` present, and does it conform? +[✔︎] Is \`tsconfig.build.json\` present, and does it conform? +[✔︎] Is \`tsup.config.ts\` present, and does it conform? +[✔︎] Is \`typedoc.json\` present, and does it conform? +[✔︎] Is \`CHANGELOG.md\` present? +[✔︎] Is \`CHANGELOG.md\` well-formatted? +[✔︎] Is \`.editorconfig\` present, and does it conform? +[✔︎] Is \`.gitattributes\` present, and does it conform? +[✔︎] Is \`.gitignore\` present, and does it conform? Results: 40 passed, 0 failed, 0 errored, 40 total Elapsed time: 0 ms @@ -915,38 +915,38 @@ Elapsed time: 0 ms repo-1 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ❌ - - The config file for Yarn Classic, \`.yarnrc\`, is present. Please upgrade this project to Yarn Modern. -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ❌ - - \`CHANGELOG.md\` does not exist in this project. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✘] Is the classic Yarn config file (\`.yarnrc\`) absent? + - The config file for Yarn Classic, \`.yarnrc\`, is present. Please upgrade this project to Yarn Modern. +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✘] Is \`CHANGELOG.md\` present? + - \`CHANGELOG.md\` does not exist in this project. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 0 passed, 15 failed, 0 errored, 15 total Elapsed time: 0 ms @@ -955,38 +955,38 @@ Elapsed time: 0 ms repo-2 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ❌ - - The config file for Yarn Classic, \`.yarnrc\`, is present. Please upgrade this project to Yarn Modern. -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ❌ - - \`CHANGELOG.md\` does not exist in this project. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✘] Is the classic Yarn config file (\`.yarnrc\`) absent? + - The config file for Yarn Classic, \`.yarnrc\`, is present. Please upgrade this project to Yarn Modern. +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✘] Is \`CHANGELOG.md\` present? + - \`CHANGELOG.md\` does not exist in this project. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 0 passed, 15 failed, 0 errored, 15 total Elapsed time: 0 ms @@ -1037,38 +1037,38 @@ Elapsed time: 0 ms repo-1 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ✅ -- Is \`CHANGELOG.md\` well-formatted? ⚠️ - - ERROR: Encountered an error validating the changelog: Could not read JSON file '${sandboxDirectoryPath}/repositories/repo-1/package.json'. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✔︎] Is \`CHANGELOG.md\` present? +[?] Is \`CHANGELOG.md\` well-formatted? + - ERROR: Encountered an error validating the changelog: Could not read JSON file '${sandboxDirectoryPath}/repositories/repo-1/package.json'. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 2 passed, 13 failed, 1 errored, 16 total Elapsed time: 0 ms @@ -1077,38 +1077,38 @@ Elapsed time: 0 ms repo-2 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ✅ -- Is \`CHANGELOG.md\` well-formatted? ⚠️ - - ERROR: Encountered an error validating the changelog: Could not read JSON file '${sandboxDirectoryPath}/repositories/repo-2/package.json'. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✔︎] Is \`CHANGELOG.md\` present? +[?] Is \`CHANGELOG.md\` well-formatted? + - ERROR: Encountered an error validating the changelog: Could not read JSON file '${sandboxDirectoryPath}/repositories/repo-2/package.json'. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 2 passed, 13 failed, 1 errored, 16 total Elapsed time: 0 ms @@ -1162,37 +1162,37 @@ Elapsed time: 0 ms repo-2 ------ -- Is the classic Yarn config file (\`.yarnrc\`) absent? ✅ -- Does the package have a well-formed manifest (\`package.json\`)? ❌ - - \`package.json\` does not exist in this project. -- Is \`README.md\` present? ❌ - - \`README.md\` does not exist in this project. -- Are all of the files for Yarn Modern present, and do they conform? ❌ - - \`.yarnrc.yml\` does not exist in this project. - - \`.yarn/releases/\` does not exist in this project. - - \`.yarn/plugins/\` does not exist in this project. -- Does the \`src/\` directory exist? ❌ - - \`src/\` does not exist in this project. -- Is \`.nvmrc\` present, and does it conform? ❌ - - \`.nvmrc\` does not exist in this project. -- Is \`jest.config.js\` present, and does it conform? ❌ - - \`jest.config.js\` does not exist in this project. -- Is \`tsconfig.json\` present, and does it conform? ❌ - - \`tsconfig.json\` does not exist in this project. -- Is \`tsconfig.build.json\` present, and does it conform? ❌ - - \`tsconfig.build.json\` does not exist in this project. -- Is \`tsup.config.ts\` present, and does it conform? ❌ - - \`tsup.config.ts\` does not exist in this project. -- Is \`typedoc.json\` present, and does it conform? ❌ - - \`typedoc.json\` does not exist in this project. -- Is \`CHANGELOG.md\` present? ❌ - - \`CHANGELOG.md\` does not exist in this project. -- Is \`.editorconfig\` present, and does it conform? ❌ - - \`.editorconfig\` does not exist in this project. -- Is \`.gitattributes\` present, and does it conform? ❌ - - \`.gitattributes\` does not exist in this project. -- Is \`.gitignore\` present, and does it conform? ❌ - - \`.gitignore\` does not exist in this project. +[✔︎] Is the classic Yarn config file (\`.yarnrc\`) absent? +[✘] Does the package have a well-formed manifest (\`package.json\`)? + - \`package.json\` does not exist in this project. +[✘] Is \`README.md\` present? + - \`README.md\` does not exist in this project. +[✘] Are all of the files for Yarn Modern present, and do they conform? + - \`.yarnrc.yml\` does not exist in this project. + - \`.yarn/releases/\` does not exist in this project. + - \`.yarn/plugins/\` does not exist in this project. +[✘] Does the \`src/\` directory exist? + - \`src/\` does not exist in this project. +[✘] Is \`.nvmrc\` present, and does it conform? + - \`.nvmrc\` does not exist in this project. +[✘] Is \`jest.config.js\` present, and does it conform? + - \`jest.config.js\` does not exist in this project. +[✘] Is \`tsconfig.json\` present, and does it conform? + - \`tsconfig.json\` does not exist in this project. +[✘] Is \`tsconfig.build.json\` present, and does it conform? + - \`tsconfig.build.json\` does not exist in this project. +[✘] Is \`tsup.config.ts\` present, and does it conform? + - \`tsup.config.ts\` does not exist in this project. +[✘] Is \`typedoc.json\` present, and does it conform? + - \`typedoc.json\` does not exist in this project. +[✘] Is \`CHANGELOG.md\` present? + - \`CHANGELOG.md\` does not exist in this project. +[✘] Is \`.editorconfig\` present, and does it conform? + - \`.editorconfig\` does not exist in this project. +[✘] Is \`.gitattributes\` present, and does it conform? + - \`.gitattributes\` does not exist in this project. +[✘] Is \`.gitignore\` present, and does it conform? + - \`.gitignore\` does not exist in this project. Results: 1 passed, 14 failed, 0 errored, 15 total Elapsed time: 0 ms diff --git a/src/report-project-lint-result.test.ts b/src/report-project-lint-result.test.ts index b96f741..2e3a49e 100644 --- a/src/report-project-lint-result.test.ts +++ b/src/report-project-lint-result.test.ts @@ -71,13 +71,13 @@ describe('reportProjectLintResult', () => { some-project ------------ -- Description for rule 1 ✅ -- Description for rule 2 ❌ - - Failure 1 - - Failure 2 -- Description for rule 3 ✅ -- Description for rule 4 ⚠️ - - ERROR: oops +[✔︎] Description for rule 1 +[✘] Description for rule 2 + - Failure 1 + - Failure 2 +[✔︎] Description for rule 3 +[?] Description for rule 4 + - ERROR: oops Results: 2 passed, 1 failed, 1 errored, 4 total Elapsed time: 30 ms diff --git a/src/report-project-lint-result.ts b/src/report-project-lint-result.ts index abfb943..aab9871 100644 --- a/src/report-project-lint-result.ts +++ b/src/report-project-lint-result.ts @@ -84,17 +84,30 @@ export function reportProjectLintResult({ /** * Determines an appropriate icon for a rule execution result. * + * Note that we include `[` and `]` around the icon in the output, but we set + * them to use the same foreground color as the background, so that they're + * hidden when using colors but visible when not. This way we can reuse this + * output for Slack messages. + * * @param ruleExecutionStatus - The status of executing a rule. * @returns The icon as a string. */ function determineIconFor(ruleExecutionStatus: RuleExecutionStatus) { if (ruleExecutionStatus === RuleExecutionStatus.Failed) { - return '❌'; + return chalk.red.bgRed('[') + chalk.white.bgRed('✘') + chalk.red.bgRed(']'); } if (ruleExecutionStatus === RuleExecutionStatus.Errored) { - return '⚠️'; + return ( + chalk.yellow.bgYellow('[') + + chalk.black.bgYellow('?') + + chalk.yellow.bgYellow(']') + ); } - return '✅'; + return ( + chalk.green.bgGreen('[') + + chalk.black.bgGreen('✔︎') + + chalk.green.bgGreen(']') + ); } /** @@ -119,9 +132,9 @@ function reportRuleExecutionResultNodes({ for (const ruleExecutionResultNode of ruleExecutionResultNodes) { outputLogger.logToStdout( - `- ${ruleExecutionResultNode.result.ruleDescription} ${determineIconFor( - ruleExecutionResultNode.result.status, - )}`, + `${determineIconFor(ruleExecutionResultNode.result.status)} ${ + ruleExecutionResultNode.result.ruleDescription + }`, ); if (ruleExecutionResultNode.result.status === RuleExecutionStatus.Passed) { @@ -132,7 +145,7 @@ function reportRuleExecutionResultNodes({ totalFailed += 1; for (const failure of ruleExecutionResultNode.result.failures) { - outputLogger.logToStdout(indent(`- ${chalk.red(failure.message)}`, 1)); + outputLogger.logToStdout(indent(`- ${chalk.red(failure.message)}`, 2)); } } else if ( ruleExecutionResultNode.result.status === RuleExecutionStatus.Errored @@ -144,7 +157,7 @@ function reportRuleExecutionResultNodes({ `- ${chalk.yellow( `ERROR: ${getErrorMessage(ruleExecutionResultNode.result.error)}`, )}`, - 1, + 2, ), ); }