From ebaf0eb53a0149ea6e7b530dbe3e158134665cc0 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 29 Jul 2024 16:04:33 +0300 Subject: [PATCH] docs-util: rename docblock-generator to docs-generator (#8331) * docs-util: rename docblock-generator to docs-generator * change program name * fix action --- .github/workflows/generate-docblocks.yml | 2 +- www/utils/.eslintrc.js | 2 +- .../.env.sample | 0 .../README.md | 42 +++++++++++++------ .../package.json | 2 +- .../src/classes/examples/oas.ts | 0 .../src/classes/generators/dml.ts | 0 .../src/classes/generators/docblock.ts | 3 ++ .../src/classes/generators/index.ts | 0 .../src/classes/generators/oas.ts | 0 .../src/classes/helpers/ai-generator.ts | 0 .../src/classes/helpers/formatter.ts | 0 .../helpers/generator-event-manager.ts | 0 .../src/classes/helpers/git-manager.ts | 0 .../classes/helpers/knowledge-base-factory.ts | 0 .../src/classes/helpers/oas-schema.ts | 0 .../src/classes/helpers/schema-factory.ts | 0 .../src/classes/kinds/default.ts | 0 .../src/classes/kinds/dml.ts | 0 .../src/classes/kinds/dto-property.ts | 0 .../src/classes/kinds/function.ts | 0 .../src/classes/kinds/medusa-react-hooks.ts | 0 .../src/classes/kinds/oas.ts | 2 +- .../src/classes/kinds/registry.ts | 0 .../src/classes/kinds/source-file.ts | 0 .../src/commands/clean-dml.ts | 0 .../src/commands/clean-oas.ts | 0 .../src/commands/run-git-changes.ts | 0 .../src/commands/run-git-commit.ts | 0 .../src/commands/run-release.ts | 0 .../src/commands/run.ts | 0 .../src/constants.ts | 0 .../src/index.ts | 2 +- .../src/types/index.d.ts | 0 .../src/utils/dirname.ts | 0 .../src/utils/filter-files.ts | 0 .../src/utils/format-oas.ts | 0 .../src/utils/get-base-path.ts | 0 .../src/utils/get-correct-zod-type-name.ts | 0 .../src/utils/get-monorepo-root.ts | 0 .../src/utils/get-output-base-paths.ts | 0 .../src/utils/get-relative-paths.ts | 0 .../src/utils/get-symbol.ts | 0 .../src/utils/is-zod-object.ts | 0 .../src/utils/medusa-react-utils.ts | 0 .../src/utils/parse-oas.ts | 0 .../src/utils/promise-exec.ts | 0 .../src/utils/str-formatting.ts | 0 .../src/utils/to-json-formatted.ts | 0 .../tsconfig.json | 0 www/utils/yarn.lock | 4 +- 51 files changed, 40 insertions(+), 19 deletions(-) rename www/utils/packages/{docblock-generator => docs-generator}/.env.sample (100%) rename www/utils/packages/{docblock-generator => docs-generator}/README.md (56%) rename www/utils/packages/{docblock-generator => docs-generator}/package.json (97%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/examples/oas.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/generators/dml.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/generators/docblock.ts (97%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/generators/index.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/generators/oas.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/helpers/ai-generator.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/helpers/formatter.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/helpers/generator-event-manager.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/helpers/git-manager.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/helpers/knowledge-base-factory.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/helpers/oas-schema.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/helpers/schema-factory.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/kinds/default.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/kinds/dml.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/kinds/dto-property.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/kinds/function.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/kinds/medusa-react-hooks.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/kinds/oas.ts (99%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/kinds/registry.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/classes/kinds/source-file.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/commands/clean-dml.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/commands/clean-oas.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/commands/run-git-changes.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/commands/run-git-commit.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/commands/run-release.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/commands/run.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/constants.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/index.ts (96%) rename www/utils/packages/{docblock-generator => docs-generator}/src/types/index.d.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/dirname.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/filter-files.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/format-oas.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/get-base-path.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/get-correct-zod-type-name.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/get-monorepo-root.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/get-output-base-paths.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/get-relative-paths.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/get-symbol.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/is-zod-object.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/medusa-react-utils.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/parse-oas.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/promise-exec.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/str-formatting.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/src/utils/to-json-formatted.ts (100%) rename www/utils/packages/{docblock-generator => docs-generator}/tsconfig.json (100%) diff --git a/.github/workflows/generate-docblocks.yml b/.github/workflows/generate-docblocks.yml index d2ccb8ced6..c67b918739 100644 --- a/.github/workflows/generate-docblocks.yml +++ b/.github/workflows/generate-docblocks.yml @@ -42,7 +42,7 @@ jobs: - name: Run docblock generator if: steps.check-commit.outputs.is_release_commit == 'true' run: "yarn start run:release --type docs" - working-directory: www/utils/packages/docblock-generator + working-directory: www/utils/packages/docs-generator env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GIT_OWNER: ${{ github.repository_owner }} diff --git a/www/utils/.eslintrc.js b/www/utils/.eslintrc.js index 74db0b2a75..3ec3ad7383 100644 --- a/www/utils/.eslintrc.js +++ b/www/utils/.eslintrc.js @@ -94,7 +94,7 @@ module.exports = { parserOptions: { project: [ "./tsconfig.json", - "./packages/docblock-generator/tsconfig.json", + "./packages/docs-generator/tsconfig.json", "./packages/react-docs-generator/tsconfig.json", "./packages/scripts/tsconfig.json", "./packages/typedoc-generate-references/tsconfig.json", diff --git a/www/utils/packages/docblock-generator/.env.sample b/www/utils/packages/docs-generator/.env.sample similarity index 100% rename from www/utils/packages/docblock-generator/.env.sample rename to www/utils/packages/docs-generator/.env.sample diff --git a/www/utils/packages/docblock-generator/README.md b/www/utils/packages/docs-generator/README.md similarity index 56% rename from www/utils/packages/docblock-generator/README.md rename to www/utils/packages/docs-generator/README.md index b4ee19699e..5e45ab539c 100644 --- a/www/utils/packages/docblock-generator/README.md +++ b/www/utils/packages/docs-generator/README.md @@ -1,12 +1,15 @@ -# docblock-generator +# docs-generator -A CLI tool that can be used to generate TSDoc docblocks and OAS for TypeScript/JavaScript files under the `packages` directory of the main monorepo. +A CLI tool that generates different types of docblocks from source code: + +- Adds TSDocs to any TypeScript file. +- Generates files with OpenApi Spec comments in `generated/oas-output`. +- Generates JSON documentation files for models built with Medusa's DML in `generated/dml-output`. ## Prerequisites 1. Run the `yarn` command to install dependencies. -2. Copy the `.env.sample` to `.env` and change the `MONOREPO_ROOT_PATH` variable to the absolute path to the monorepo root. -3. Run the `yarn build` command to build source files. +2. Run the `yarn build` command to build source files. --- @@ -17,7 +20,7 @@ A CLI tool that can be used to generate TSDoc docblocks and OAS for TypeScript/J Run the following command to run the tool for a specific file: ```bash -yarn start run /absolute/path/to/file.ts +yarn dev run /absolute/path/to/file.ts ``` ### Generate for git-changed files @@ -25,7 +28,7 @@ yarn start run /absolute/path/to/file.ts Run the following command to run the tool for applicable git file changes: ```bash -yarn start run:changes +yarn dev run:changes ``` ### Generate for a specific commit @@ -33,7 +36,7 @@ yarn start run:changes Run the following command to run the tool for a commit SHA hash: ```bash -yarn start run:commit +yarn dev run:commit ``` Where `` is the SHA of the commit. For example, `e28fa7fbdf45c5b1fa19848db731132a0bf1757d`. @@ -43,7 +46,7 @@ Where `` is the SHA of the commit. For example, `e28fa7fbdf45c5b1fa1 Run the following command to run the tool on commits since the latest release. ```bash -yarn start run:release +yarn dev run:release ``` ### Clean OAS @@ -51,11 +54,19 @@ yarn start run:release Run the following command to clean up the OAS output files and remove any routes that no longer exist: ```bash -yarn start clean:oas +yarn dev clean:oas ``` This command will also remove tags and schemas not used. +### Clean DML JSON files + +Run the following command to clean up the DML JSON output files and remove any data models that no longer exist: + +```bash +yarn dev clean:dml +``` + --- ## How it Works @@ -64,11 +75,17 @@ This command will also remove tags and schemas not used. If a node is an API route, it generates OAS comments rather than TSDoc comments. The OAS comments are generated and placed in new/existing files under the `www/utils/generated/oas-output/operations` directory. +## Models Built with DML + +If a node is a `CallExpression` and it's created using `model.define`, then a JSON documentation file with key-value pairs is generated to add description to its properties. + +Only files under `packages/modules/**/src/models` are considered here. + ### Generating TSDoc Docblocks -If a note isn't an API Route and it complies with the specified conditions, TSDoc docblocks are generated for it. +If a node isn't an API Route and it complies with the specified conditions, TSDoc docblocks are generated for it. -Files under the `packages/medusa/src/api` or `api-v2` directories are considered incompatible, so any files under these directories won't have TSDoc docblocks generated for them. +Files under the `packages/medusa/src/api` or `packages/modules/**/src/models` directories are considered incompatible, so any files under these directories won't have TSDoc docblocks generated for them. --- @@ -88,4 +105,5 @@ You can use this option to specify the type of docs to generate. Possible values - `all`: (default) Generate all doc types. - `docs`: Generate only TSDoc docblocks. -- `oas`: Generate only OAS docblocks/files. +- `oas`: Generate only OAS files. +- `dml`: Generate only JSON files for models built with DML. \ No newline at end of file diff --git a/www/utils/packages/docblock-generator/package.json b/www/utils/packages/docs-generator/package.json similarity index 97% rename from www/utils/packages/docblock-generator/package.json rename to www/utils/packages/docs-generator/package.json index 926605f82a..ec4f47f237 100644 --- a/www/utils/packages/docblock-generator/package.json +++ b/www/utils/packages/docs-generator/package.json @@ -1,5 +1,5 @@ { - "name": "docblock-generator", + "name": "docs-generator", "license": "MIT", "scripts": { "dev": "node --loader ts-node/esm src/index.ts", diff --git a/www/utils/packages/docblock-generator/src/classes/examples/oas.ts b/www/utils/packages/docs-generator/src/classes/examples/oas.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/examples/oas.ts rename to www/utils/packages/docs-generator/src/classes/examples/oas.ts diff --git a/www/utils/packages/docblock-generator/src/classes/generators/dml.ts b/www/utils/packages/docs-generator/src/classes/generators/dml.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/generators/dml.ts rename to www/utils/packages/docs-generator/src/classes/generators/dml.ts diff --git a/www/utils/packages/docblock-generator/src/classes/generators/docblock.ts b/www/utils/packages/docs-generator/src/classes/generators/docblock.ts similarity index 97% rename from www/utils/packages/docblock-generator/src/classes/generators/docblock.ts rename to www/utils/packages/docs-generator/src/classes/generators/docblock.ts index 9aa69710bb..5ca24a633e 100644 --- a/www/utils/packages/docblock-generator/src/classes/generators/docblock.ts +++ b/www/utils/packages/docs-generator/src/classes/generators/docblock.ts @@ -167,6 +167,9 @@ class DocblockGenerator extends AbstractGenerator { super.isFileIncluded(fileName) && !minimatch(getBasePath(fileName), "packages/medusa/**/api**/**", { matchBase: true, + }) && + !minimatch(getBasePath(fileName), "packages/modules/**/models/**", { + matchBase: true, }) ) } diff --git a/www/utils/packages/docblock-generator/src/classes/generators/index.ts b/www/utils/packages/docs-generator/src/classes/generators/index.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/generators/index.ts rename to www/utils/packages/docs-generator/src/classes/generators/index.ts diff --git a/www/utils/packages/docblock-generator/src/classes/generators/oas.ts b/www/utils/packages/docs-generator/src/classes/generators/oas.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/generators/oas.ts rename to www/utils/packages/docs-generator/src/classes/generators/oas.ts diff --git a/www/utils/packages/docblock-generator/src/classes/helpers/ai-generator.ts b/www/utils/packages/docs-generator/src/classes/helpers/ai-generator.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/helpers/ai-generator.ts rename to www/utils/packages/docs-generator/src/classes/helpers/ai-generator.ts diff --git a/www/utils/packages/docblock-generator/src/classes/helpers/formatter.ts b/www/utils/packages/docs-generator/src/classes/helpers/formatter.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/helpers/formatter.ts rename to www/utils/packages/docs-generator/src/classes/helpers/formatter.ts diff --git a/www/utils/packages/docblock-generator/src/classes/helpers/generator-event-manager.ts b/www/utils/packages/docs-generator/src/classes/helpers/generator-event-manager.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/helpers/generator-event-manager.ts rename to www/utils/packages/docs-generator/src/classes/helpers/generator-event-manager.ts diff --git a/www/utils/packages/docblock-generator/src/classes/helpers/git-manager.ts b/www/utils/packages/docs-generator/src/classes/helpers/git-manager.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/helpers/git-manager.ts rename to www/utils/packages/docs-generator/src/classes/helpers/git-manager.ts diff --git a/www/utils/packages/docblock-generator/src/classes/helpers/knowledge-base-factory.ts b/www/utils/packages/docs-generator/src/classes/helpers/knowledge-base-factory.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/helpers/knowledge-base-factory.ts rename to www/utils/packages/docs-generator/src/classes/helpers/knowledge-base-factory.ts diff --git a/www/utils/packages/docblock-generator/src/classes/helpers/oas-schema.ts b/www/utils/packages/docs-generator/src/classes/helpers/oas-schema.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/helpers/oas-schema.ts rename to www/utils/packages/docs-generator/src/classes/helpers/oas-schema.ts diff --git a/www/utils/packages/docblock-generator/src/classes/helpers/schema-factory.ts b/www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/helpers/schema-factory.ts rename to www/utils/packages/docs-generator/src/classes/helpers/schema-factory.ts diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/default.ts b/www/utils/packages/docs-generator/src/classes/kinds/default.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/kinds/default.ts rename to www/utils/packages/docs-generator/src/classes/kinds/default.ts diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/dml.ts b/www/utils/packages/docs-generator/src/classes/kinds/dml.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/kinds/dml.ts rename to www/utils/packages/docs-generator/src/classes/kinds/dml.ts diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/dto-property.ts b/www/utils/packages/docs-generator/src/classes/kinds/dto-property.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/kinds/dto-property.ts rename to www/utils/packages/docs-generator/src/classes/kinds/dto-property.ts diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/function.ts b/www/utils/packages/docs-generator/src/classes/kinds/function.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/kinds/function.ts rename to www/utils/packages/docs-generator/src/classes/kinds/function.ts diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/medusa-react-hooks.ts b/www/utils/packages/docs-generator/src/classes/kinds/medusa-react-hooks.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/kinds/medusa-react-hooks.ts rename to www/utils/packages/docs-generator/src/classes/kinds/medusa-react-hooks.ts diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/oas.ts b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts similarity index 99% rename from www/utils/packages/docblock-generator/src/classes/kinds/oas.ts rename to www/utils/packages/docs-generator/src/classes/kinds/oas.ts index e2bde964d7..529fd7c3fd 100644 --- a/www/utils/packages/docblock-generator/src/classes/kinds/oas.ts +++ b/www/utils/packages/docs-generator/src/classes/kinds/oas.ts @@ -25,7 +25,7 @@ import FunctionKindGenerator, { FunctionOrVariableNode, VariableNode, } from "./function.js" -import { API_ROUTE_PARAM_REGEX } from "../helpers/../../constants.js" +import { API_ROUTE_PARAM_REGEX } from "../../constants.js" const RES_STATUS_REGEX = /^res[\s\S]*\.status\((\d+)\)/ diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/registry.ts b/www/utils/packages/docs-generator/src/classes/kinds/registry.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/kinds/registry.ts rename to www/utils/packages/docs-generator/src/classes/kinds/registry.ts diff --git a/www/utils/packages/docblock-generator/src/classes/kinds/source-file.ts b/www/utils/packages/docs-generator/src/classes/kinds/source-file.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/classes/kinds/source-file.ts rename to www/utils/packages/docs-generator/src/classes/kinds/source-file.ts diff --git a/www/utils/packages/docblock-generator/src/commands/clean-dml.ts b/www/utils/packages/docs-generator/src/commands/clean-dml.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/commands/clean-dml.ts rename to www/utils/packages/docs-generator/src/commands/clean-dml.ts diff --git a/www/utils/packages/docblock-generator/src/commands/clean-oas.ts b/www/utils/packages/docs-generator/src/commands/clean-oas.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/commands/clean-oas.ts rename to www/utils/packages/docs-generator/src/commands/clean-oas.ts diff --git a/www/utils/packages/docblock-generator/src/commands/run-git-changes.ts b/www/utils/packages/docs-generator/src/commands/run-git-changes.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/commands/run-git-changes.ts rename to www/utils/packages/docs-generator/src/commands/run-git-changes.ts diff --git a/www/utils/packages/docblock-generator/src/commands/run-git-commit.ts b/www/utils/packages/docs-generator/src/commands/run-git-commit.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/commands/run-git-commit.ts rename to www/utils/packages/docs-generator/src/commands/run-git-commit.ts diff --git a/www/utils/packages/docblock-generator/src/commands/run-release.ts b/www/utils/packages/docs-generator/src/commands/run-release.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/commands/run-release.ts rename to www/utils/packages/docs-generator/src/commands/run-release.ts diff --git a/www/utils/packages/docblock-generator/src/commands/run.ts b/www/utils/packages/docs-generator/src/commands/run.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/commands/run.ts rename to www/utils/packages/docs-generator/src/commands/run.ts diff --git a/www/utils/packages/docblock-generator/src/constants.ts b/www/utils/packages/docs-generator/src/constants.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/constants.ts rename to www/utils/packages/docs-generator/src/constants.ts diff --git a/www/utils/packages/docblock-generator/src/index.ts b/www/utils/packages/docs-generator/src/index.ts similarity index 96% rename from www/utils/packages/docblock-generator/src/index.ts rename to www/utils/packages/docs-generator/src/index.ts index c15697f808..6a035228d9 100644 --- a/www/utils/packages/docblock-generator/src/index.ts +++ b/www/utils/packages/docs-generator/src/index.ts @@ -10,7 +10,7 @@ import cleanDml from "./commands/clean-dml.js" const program = new Command() -program.name("docblock-generator").description("Generate TSDoc doc-blocks") +program.name("docs-generator").description("Generate TSDoc doc-blocks") // define common options const typeOption = new Option("--type ", "The type of docs to generate.") diff --git a/www/utils/packages/docblock-generator/src/types/index.d.ts b/www/utils/packages/docs-generator/src/types/index.d.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/types/index.d.ts rename to www/utils/packages/docs-generator/src/types/index.d.ts diff --git a/www/utils/packages/docblock-generator/src/utils/dirname.ts b/www/utils/packages/docs-generator/src/utils/dirname.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/dirname.ts rename to www/utils/packages/docs-generator/src/utils/dirname.ts diff --git a/www/utils/packages/docblock-generator/src/utils/filter-files.ts b/www/utils/packages/docs-generator/src/utils/filter-files.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/filter-files.ts rename to www/utils/packages/docs-generator/src/utils/filter-files.ts diff --git a/www/utils/packages/docblock-generator/src/utils/format-oas.ts b/www/utils/packages/docs-generator/src/utils/format-oas.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/format-oas.ts rename to www/utils/packages/docs-generator/src/utils/format-oas.ts diff --git a/www/utils/packages/docblock-generator/src/utils/get-base-path.ts b/www/utils/packages/docs-generator/src/utils/get-base-path.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/get-base-path.ts rename to www/utils/packages/docs-generator/src/utils/get-base-path.ts diff --git a/www/utils/packages/docblock-generator/src/utils/get-correct-zod-type-name.ts b/www/utils/packages/docs-generator/src/utils/get-correct-zod-type-name.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/get-correct-zod-type-name.ts rename to www/utils/packages/docs-generator/src/utils/get-correct-zod-type-name.ts diff --git a/www/utils/packages/docblock-generator/src/utils/get-monorepo-root.ts b/www/utils/packages/docs-generator/src/utils/get-monorepo-root.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/get-monorepo-root.ts rename to www/utils/packages/docs-generator/src/utils/get-monorepo-root.ts diff --git a/www/utils/packages/docblock-generator/src/utils/get-output-base-paths.ts b/www/utils/packages/docs-generator/src/utils/get-output-base-paths.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/get-output-base-paths.ts rename to www/utils/packages/docs-generator/src/utils/get-output-base-paths.ts diff --git a/www/utils/packages/docblock-generator/src/utils/get-relative-paths.ts b/www/utils/packages/docs-generator/src/utils/get-relative-paths.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/get-relative-paths.ts rename to www/utils/packages/docs-generator/src/utils/get-relative-paths.ts diff --git a/www/utils/packages/docblock-generator/src/utils/get-symbol.ts b/www/utils/packages/docs-generator/src/utils/get-symbol.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/get-symbol.ts rename to www/utils/packages/docs-generator/src/utils/get-symbol.ts diff --git a/www/utils/packages/docblock-generator/src/utils/is-zod-object.ts b/www/utils/packages/docs-generator/src/utils/is-zod-object.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/is-zod-object.ts rename to www/utils/packages/docs-generator/src/utils/is-zod-object.ts diff --git a/www/utils/packages/docblock-generator/src/utils/medusa-react-utils.ts b/www/utils/packages/docs-generator/src/utils/medusa-react-utils.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/medusa-react-utils.ts rename to www/utils/packages/docs-generator/src/utils/medusa-react-utils.ts diff --git a/www/utils/packages/docblock-generator/src/utils/parse-oas.ts b/www/utils/packages/docs-generator/src/utils/parse-oas.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/parse-oas.ts rename to www/utils/packages/docs-generator/src/utils/parse-oas.ts diff --git a/www/utils/packages/docblock-generator/src/utils/promise-exec.ts b/www/utils/packages/docs-generator/src/utils/promise-exec.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/promise-exec.ts rename to www/utils/packages/docs-generator/src/utils/promise-exec.ts diff --git a/www/utils/packages/docblock-generator/src/utils/str-formatting.ts b/www/utils/packages/docs-generator/src/utils/str-formatting.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/str-formatting.ts rename to www/utils/packages/docs-generator/src/utils/str-formatting.ts diff --git a/www/utils/packages/docblock-generator/src/utils/to-json-formatted.ts b/www/utils/packages/docs-generator/src/utils/to-json-formatted.ts similarity index 100% rename from www/utils/packages/docblock-generator/src/utils/to-json-formatted.ts rename to www/utils/packages/docs-generator/src/utils/to-json-formatted.ts diff --git a/www/utils/packages/docblock-generator/tsconfig.json b/www/utils/packages/docs-generator/tsconfig.json similarity index 100% rename from www/utils/packages/docblock-generator/tsconfig.json rename to www/utils/packages/docs-generator/tsconfig.json diff --git a/www/utils/yarn.lock b/www/utils/yarn.lock index 2cc8db0453..9999c737e4 100644 --- a/www/utils/yarn.lock +++ b/www/utils/yarn.lock @@ -2343,9 +2343,9 @@ __metadata: languageName: node linkType: hard -"docblock-generator@workspace:packages/docblock-generator": +"docs-generator@workspace:packages/docs-generator": version: 0.0.0-use.local - resolution: "docblock-generator@workspace:packages/docblock-generator" + resolution: "docs-generator@workspace:packages/docs-generator" dependencies: "@faker-js/faker": ^8.4.0 "@octokit/core": ^5.0.2