From 86544fcd8f608c4c729d2a8bf51957f2621a2cf7 Mon Sep 17 00:00:00 2001 From: Isaac Lee <16869656+ijlee2@users.noreply.github.com> Date: Sun, 9 Jul 2023 17:35:32 +0200 Subject: [PATCH] Ensured that blueprint files are installed (#45) * bugfix: Ensured that .github folder is present * bugfix: Ensured that tests folder is present * bugfix: Ensured that root files are present * chore: Added changeset --------- Co-authored-by: ijlee2 --- .changeset/tricky-birds-think.md | 5 +++++ .../{CONTRIBUTING.md => __CONTRIBUTING.md__} | 0 .../cli/src/blueprints/{build.sh => __build.sh__} | 0 ...test-fixture.sh => __codemod-test-fixture.sh__} | 0 ...st-fixtures.sh => __codemod-test-fixtures.sh__} | 0 .../blueprints/{.eslintignore => __eslintignore__} | 0 .../blueprints/{.eslintrc.cjs => __eslintrc.cjs__} | 0 .../ISSUE_TEMPLATE/ask-for-better-documentation.md | 0 .../ask-for-new-feature-or-refactor.md | 0 .../ISSUE_TEMPLATE/report-bug.md | 0 .../ISSUE_TEMPLATE/report-outdated-dependency.md | 0 .../{.github => __github__}/workflows/ci.yml | 0 .../src/blueprints/{.npmignore => __npmignore__} | 0 .../{.prettierrc.cjs => __prettierrc.cjs__} | 0 .../fixtures/sample-project/index.__js__ | 0 .../fixtures/sample-project/input/file.txt | 0 .../fixtures/sample-project/output/file.txt | 0 .../shared-test-setups/sample-project.__js__ | 0 .../index/sample-project.test.__js__ | 0 .../steps/add-end-of-line/base-case.test.__js__ | 0 .../edge-case-file-ends-with-newline.test.__js__ | 0 .../edge-case-file-is-empty.test.__js__ | 0 .../create-options/sample-project.test.__js__ | 0 .../utils/blueprints/blueprints-root.test.__js__ | 0 .../steps/create-files-from-blueprints.ts | 14 ++++++++++++-- 25 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 .changeset/tricky-birds-think.md rename packages/cli/src/blueprints/{CONTRIBUTING.md => __CONTRIBUTING.md__} (100%) rename packages/cli/src/blueprints/{build.sh => __build.sh__} (100%) rename packages/cli/src/blueprints/{codemod-test-fixture.sh => __codemod-test-fixture.sh__} (100%) rename packages/cli/src/blueprints/{codemod-test-fixtures.sh => __codemod-test-fixtures.sh__} (100%) rename packages/cli/src/blueprints/{.eslintignore => __eslintignore__} (100%) rename packages/cli/src/blueprints/{.eslintrc.cjs => __eslintrc.cjs__} (100%) rename packages/cli/src/blueprints/{.github => __github__}/ISSUE_TEMPLATE/ask-for-better-documentation.md (100%) rename packages/cli/src/blueprints/{.github => __github__}/ISSUE_TEMPLATE/ask-for-new-feature-or-refactor.md (100%) rename packages/cli/src/blueprints/{.github => __github__}/ISSUE_TEMPLATE/report-bug.md (100%) rename packages/cli/src/blueprints/{.github => __github__}/ISSUE_TEMPLATE/report-outdated-dependency.md (100%) rename packages/cli/src/blueprints/{.github => __github__}/workflows/ci.yml (100%) rename packages/cli/src/blueprints/{.npmignore => __npmignore__} (100%) rename packages/cli/src/blueprints/{.prettierrc.cjs => __prettierrc.cjs__} (100%) rename packages/cli/src/blueprints/{tests => __tests__}/fixtures/sample-project/index.__js__ (100%) rename packages/cli/src/blueprints/{tests => __tests__}/fixtures/sample-project/input/file.txt (100%) rename packages/cli/src/blueprints/{tests => __tests__}/fixtures/sample-project/output/file.txt (100%) rename packages/cli/src/blueprints/{tests => __tests__}/helpers/shared-test-setups/sample-project.__js__ (100%) rename packages/cli/src/blueprints/{tests => __tests__}/index/sample-project.test.__js__ (100%) rename packages/cli/src/blueprints/{tests => __tests__}/steps/add-end-of-line/base-case.test.__js__ (100%) rename packages/cli/src/blueprints/{tests => __tests__}/steps/add-end-of-line/edge-case-file-ends-with-newline.test.__js__ (100%) rename packages/cli/src/blueprints/{tests => __tests__}/steps/add-end-of-line/edge-case-file-is-empty.test.__js__ (100%) rename packages/cli/src/blueprints/{tests => __tests__}/steps/create-options/sample-project.test.__js__ (100%) rename packages/cli/src/blueprints/{tests => __tests__}/utils/blueprints/blueprints-root.test.__js__ (100%) diff --git a/.changeset/tricky-birds-think.md b/.changeset/tricky-birds-think.md new file mode 100644 index 00000000..8e674bca --- /dev/null +++ b/.changeset/tricky-birds-think.md @@ -0,0 +1,5 @@ +--- +"@codemod-utils/cli": patch +--- + +Ensured that blueprints files are installed diff --git a/packages/cli/src/blueprints/CONTRIBUTING.md b/packages/cli/src/blueprints/__CONTRIBUTING.md__ similarity index 100% rename from packages/cli/src/blueprints/CONTRIBUTING.md rename to packages/cli/src/blueprints/__CONTRIBUTING.md__ diff --git a/packages/cli/src/blueprints/build.sh b/packages/cli/src/blueprints/__build.sh__ similarity index 100% rename from packages/cli/src/blueprints/build.sh rename to packages/cli/src/blueprints/__build.sh__ diff --git a/packages/cli/src/blueprints/codemod-test-fixture.sh b/packages/cli/src/blueprints/__codemod-test-fixture.sh__ similarity index 100% rename from packages/cli/src/blueprints/codemod-test-fixture.sh rename to packages/cli/src/blueprints/__codemod-test-fixture.sh__ diff --git a/packages/cli/src/blueprints/codemod-test-fixtures.sh b/packages/cli/src/blueprints/__codemod-test-fixtures.sh__ similarity index 100% rename from packages/cli/src/blueprints/codemod-test-fixtures.sh rename to packages/cli/src/blueprints/__codemod-test-fixtures.sh__ diff --git a/packages/cli/src/blueprints/.eslintignore b/packages/cli/src/blueprints/__eslintignore__ similarity index 100% rename from packages/cli/src/blueprints/.eslintignore rename to packages/cli/src/blueprints/__eslintignore__ diff --git a/packages/cli/src/blueprints/.eslintrc.cjs b/packages/cli/src/blueprints/__eslintrc.cjs__ similarity index 100% rename from packages/cli/src/blueprints/.eslintrc.cjs rename to packages/cli/src/blueprints/__eslintrc.cjs__ diff --git a/packages/cli/src/blueprints/.github/ISSUE_TEMPLATE/ask-for-better-documentation.md b/packages/cli/src/blueprints/__github__/ISSUE_TEMPLATE/ask-for-better-documentation.md similarity index 100% rename from packages/cli/src/blueprints/.github/ISSUE_TEMPLATE/ask-for-better-documentation.md rename to packages/cli/src/blueprints/__github__/ISSUE_TEMPLATE/ask-for-better-documentation.md diff --git a/packages/cli/src/blueprints/.github/ISSUE_TEMPLATE/ask-for-new-feature-or-refactor.md b/packages/cli/src/blueprints/__github__/ISSUE_TEMPLATE/ask-for-new-feature-or-refactor.md similarity index 100% rename from packages/cli/src/blueprints/.github/ISSUE_TEMPLATE/ask-for-new-feature-or-refactor.md rename to packages/cli/src/blueprints/__github__/ISSUE_TEMPLATE/ask-for-new-feature-or-refactor.md diff --git a/packages/cli/src/blueprints/.github/ISSUE_TEMPLATE/report-bug.md b/packages/cli/src/blueprints/__github__/ISSUE_TEMPLATE/report-bug.md similarity index 100% rename from packages/cli/src/blueprints/.github/ISSUE_TEMPLATE/report-bug.md rename to packages/cli/src/blueprints/__github__/ISSUE_TEMPLATE/report-bug.md diff --git a/packages/cli/src/blueprints/.github/ISSUE_TEMPLATE/report-outdated-dependency.md b/packages/cli/src/blueprints/__github__/ISSUE_TEMPLATE/report-outdated-dependency.md similarity index 100% rename from packages/cli/src/blueprints/.github/ISSUE_TEMPLATE/report-outdated-dependency.md rename to packages/cli/src/blueprints/__github__/ISSUE_TEMPLATE/report-outdated-dependency.md diff --git a/packages/cli/src/blueprints/.github/workflows/ci.yml b/packages/cli/src/blueprints/__github__/workflows/ci.yml similarity index 100% rename from packages/cli/src/blueprints/.github/workflows/ci.yml rename to packages/cli/src/blueprints/__github__/workflows/ci.yml diff --git a/packages/cli/src/blueprints/.npmignore b/packages/cli/src/blueprints/__npmignore__ similarity index 100% rename from packages/cli/src/blueprints/.npmignore rename to packages/cli/src/blueprints/__npmignore__ diff --git a/packages/cli/src/blueprints/.prettierrc.cjs b/packages/cli/src/blueprints/__prettierrc.cjs__ similarity index 100% rename from packages/cli/src/blueprints/.prettierrc.cjs rename to packages/cli/src/blueprints/__prettierrc.cjs__ diff --git a/packages/cli/src/blueprints/tests/fixtures/sample-project/index.__js__ b/packages/cli/src/blueprints/__tests__/fixtures/sample-project/index.__js__ similarity index 100% rename from packages/cli/src/blueprints/tests/fixtures/sample-project/index.__js__ rename to packages/cli/src/blueprints/__tests__/fixtures/sample-project/index.__js__ diff --git a/packages/cli/src/blueprints/tests/fixtures/sample-project/input/file.txt b/packages/cli/src/blueprints/__tests__/fixtures/sample-project/input/file.txt similarity index 100% rename from packages/cli/src/blueprints/tests/fixtures/sample-project/input/file.txt rename to packages/cli/src/blueprints/__tests__/fixtures/sample-project/input/file.txt diff --git a/packages/cli/src/blueprints/tests/fixtures/sample-project/output/file.txt b/packages/cli/src/blueprints/__tests__/fixtures/sample-project/output/file.txt similarity index 100% rename from packages/cli/src/blueprints/tests/fixtures/sample-project/output/file.txt rename to packages/cli/src/blueprints/__tests__/fixtures/sample-project/output/file.txt diff --git a/packages/cli/src/blueprints/tests/helpers/shared-test-setups/sample-project.__js__ b/packages/cli/src/blueprints/__tests__/helpers/shared-test-setups/sample-project.__js__ similarity index 100% rename from packages/cli/src/blueprints/tests/helpers/shared-test-setups/sample-project.__js__ rename to packages/cli/src/blueprints/__tests__/helpers/shared-test-setups/sample-project.__js__ diff --git a/packages/cli/src/blueprints/tests/index/sample-project.test.__js__ b/packages/cli/src/blueprints/__tests__/index/sample-project.test.__js__ similarity index 100% rename from packages/cli/src/blueprints/tests/index/sample-project.test.__js__ rename to packages/cli/src/blueprints/__tests__/index/sample-project.test.__js__ diff --git a/packages/cli/src/blueprints/tests/steps/add-end-of-line/base-case.test.__js__ b/packages/cli/src/blueprints/__tests__/steps/add-end-of-line/base-case.test.__js__ similarity index 100% rename from packages/cli/src/blueprints/tests/steps/add-end-of-line/base-case.test.__js__ rename to packages/cli/src/blueprints/__tests__/steps/add-end-of-line/base-case.test.__js__ diff --git a/packages/cli/src/blueprints/tests/steps/add-end-of-line/edge-case-file-ends-with-newline.test.__js__ b/packages/cli/src/blueprints/__tests__/steps/add-end-of-line/edge-case-file-ends-with-newline.test.__js__ similarity index 100% rename from packages/cli/src/blueprints/tests/steps/add-end-of-line/edge-case-file-ends-with-newline.test.__js__ rename to packages/cli/src/blueprints/__tests__/steps/add-end-of-line/edge-case-file-ends-with-newline.test.__js__ diff --git a/packages/cli/src/blueprints/tests/steps/add-end-of-line/edge-case-file-is-empty.test.__js__ b/packages/cli/src/blueprints/__tests__/steps/add-end-of-line/edge-case-file-is-empty.test.__js__ similarity index 100% rename from packages/cli/src/blueprints/tests/steps/add-end-of-line/edge-case-file-is-empty.test.__js__ rename to packages/cli/src/blueprints/__tests__/steps/add-end-of-line/edge-case-file-is-empty.test.__js__ diff --git a/packages/cli/src/blueprints/tests/steps/create-options/sample-project.test.__js__ b/packages/cli/src/blueprints/__tests__/steps/create-options/sample-project.test.__js__ similarity index 100% rename from packages/cli/src/blueprints/tests/steps/create-options/sample-project.test.__js__ rename to packages/cli/src/blueprints/__tests__/steps/create-options/sample-project.test.__js__ diff --git a/packages/cli/src/blueprints/tests/utils/blueprints/blueprints-root.test.__js__ b/packages/cli/src/blueprints/__tests__/utils/blueprints/blueprints-root.test.__js__ similarity index 100% rename from packages/cli/src/blueprints/tests/utils/blueprints/blueprints-root.test.__js__ rename to packages/cli/src/blueprints/__tests__/utils/blueprints/blueprints-root.test.__js__ diff --git a/packages/cli/src/migration/steps/create-files-from-blueprints.ts b/packages/cli/src/migration/steps/create-files-from-blueprints.ts index 3e64c5c6..2f743c48 100644 --- a/packages/cli/src/migration/steps/create-files-from-blueprints.ts +++ b/packages/cli/src/migration/steps/create-files-from-blueprints.ts @@ -16,11 +16,11 @@ function getFilesToSkip(options: Options): string[] { files.add('src/blueprints/.gitkeep'); files.add('src/utils/blueprints/blueprints-root.__js__'); files.add('src/utils/blueprints.__js__'); - files.add('tests/utils/blueprints/blueprints-root.test.__js__'); + files.add('__tests__/utils/blueprints/blueprints-root.test.__js__'); } if (!codemod.hasTypeScript) { - files.add('build.sh'); + files.add('__build.sh__'); files.add('src/types/index.ts'); files.add('tsconfig.build.json'); files.add('tsconfig.json'); @@ -36,8 +36,18 @@ function resolveBlueprintFilePath( const { codemod } = options; return blueprintFilePath + .replace('__github__/', '.github/') + .replace('__tests__/', 'tests/') .replace('__codemod-name__', codemod.name) + .replace('__eslintignore__', '.eslintignore') + .replace('__eslintrc.cjs__', '.eslintrc.cjs') .replace('__gitignore__', '.gitignore') + .replace('__npmignore__', '.npmignore') + .replace('__prettierrc.cjs__', '.prettierrc.cjs') + .replace('__build.sh__', 'build.sh') + .replace('__codemod-test-fixture.sh__', 'codemod-test-fixture.sh') + .replace('__codemod-test-fixtures.sh__', 'codemod-test-fixtures.sh') + .replace('__CONTRIBUTING.md__', 'CONTRIBUTING.md') .replace('.__js__', codemod.hasTypeScript ? '.ts' : '.js'); }