🔧 clean: remove typedoc @public @internal @decorator (#2162)

- remove `@public` doc tag - remove `@decorator` doc tag - remove `@internal` doc tag - remove `sources/deprecated` from source tree refers: - none ## Type of change **PATCH: backwards compatible change** This PR includes breaking changes to the following core packages: - none This PR includes breaking changes to the follow extensions: - none ## Dependencies ### Adds - none ### Removes - none
roots · Mar 14, 2023 · c26f3de · c26f3de
1 parent 6a99f14
commit c26f3de
Show file tree

Hide file tree

Showing 228 changed files with 120 additions and 3,032 deletions.
diff --git a/sources/@repo/constants/index.d.ts b/sources/@repo/constants/index.d.ts
@@ -1,20 +1,15 @@
 /**
  * Repo root path
- *
- * @public
  */
 export declare const REPO_PATH: string
+
 /**
  * Repo root manifest path
- *
- * @public
  */
 export declare const ROOT_MANIFEST_PATH: string
 
 /*
  * Storage root path
- *
- * @public
  */
 export declare const STORAGE_PATH: string
 
@@ -23,22 +18,16 @@ export declare const STORAGE_PATH: string
  *
  * @remarks
  * This should be a part of jest config (once all integration tests are rewritten for verdaccio)
- *
- * @public
  */
 export declare const INTEGRATION_TESTS: Array<string>
 
 /**
  * Base public package tsconfig (CJS)
- *
- * @public
  */
 export declare const TS_CONFIG_PATH: string
 
 /**
  * Proxy registry URL
- *
- * @public
  */
 export declare const REGISTRY_PROXY: string
 

diff --git a/sources/@repo/constants/index.js b/sources/@repo/constants/index.js
@@ -4,8 +4,6 @@ import {fileURLToPath} from 'node:url'
 
 /**
  * Repo root path
- *
- * @public
  */
 // @ts-ignore
 export const REPO_PATH = (
@@ -18,29 +16,21 @@ export const REPO_PATH = (
 
 /**
  * Repo root manifest path
- *
- * @public
  */
 export const ROOT_MANIFEST_PATH = join(REPO_PATH, `package.json`)
 
 /*
  * Storage root path
- *
- * @public
  */
 export const STORAGE_PATH = join(REPO_PATH, `storage`)
 
 /**
  * Base public package tsconfig (CJS)
- *
- * @public
  */
 export const TS_CONFIG_PATH = join(REPO_PATH, `config`, `tsconfig.json`)
 
 /**
  * Proxy registry URL
- *
- * @public
  */
 export const REGISTRY_PROXY = `http://localhost:4873`
 

diff --git a/sources/@repo/docs/config/docusaurus.theme.cjs b/sources/@repo/docs/config/docusaurus.theme.cjs
@@ -4,8 +4,6 @@ const config = require(`../../../../config/monorepo.config.cjs`)
 
 /**
  * Announcement bar config
- *
- * @public
  */
 const announcementBar = {
   id: `announcementBar-5`, // Increment on change
@@ -14,8 +12,6 @@ const announcementBar = {
 
 /**
  * Footer config
- *
- * @public
  */
 const footer = {
   style: `dark`,
@@ -71,8 +67,6 @@ const footer = {
 
 /**
  * Metaadata config
- *
- * @public
  */
 const metadata = [
   /**
@@ -173,8 +167,6 @@ const navbar = {
 
 /**
  * Prism theme config
- *
- * @public
  */
 const prism = {
   additionalLanguages: [`php`],

diff --git a/sources/@repo/docs/content/guides/extending/index.mdx b/sources/@repo/docs/content/guides/extending/index.mdx
@@ -274,32 +274,24 @@ A plugin is defined as a newable class or function returning an object with an `
 ```ts title="extension.d.ts"
 /**
  * Webpack plugin.
- *
- * @public
  */
 export interface ApplyPlugin {
   /**
    * Loose defined
-   *
-   * @public
    */
   [key: string]: any
 
   /**
    * Apply callback
    *
    * @see {@link https://webpack.js.org/contribute/writing-a-plugin/#basic-plugin-architecture}
-   *
-   * @public
    */
   apply: (compiler?: Compiler) => unknown
 }
 
 /**
  * Newable function or class that returns
  * an {@link ApplyPlugin} instance.
- *
- * @public
  */
 export interface ApplyPluginConstructor {
   new (...args: any[]): ApplyPlugin

diff --git a/sources/@repo/docs/content/guides/general-use/managing-dependencies.mdx b/sources/@repo/docs/content/guides/general-use/managing-dependencies.mdx
@@ -46,9 +46,6 @@ class BudVueExtension {
   // ...
   /**
    * Returns true if user has installed a 2.x.x version of vue
-   *
-   * @public
-   * @decorator `@bind`
    */
   @bind
   protected async isVue2() {

diff --git a/sources/@repo/test-kit/project.ts b/sources/@repo/test-kit/project.ts
@@ -36,8 +36,6 @@ interface Options {
  *  expect(project.assets['main.js'].length).toBeGreaterThan(10)
  *  ...
  * ```
- *
- * @internal
  */
 export class Project {
   public assets = {}
@@ -63,15 +61,11 @@ export class Project {
 
   /**
    * dir
-   *
-   * @public
    */
   public dir: string
 
   /**
    * Class constructor
-   *
-   * @public
    */
   public constructor(public options: Options) {
     this.dir = join(paths.mocks, this.options.with, this.options.label)
@@ -80,9 +74,6 @@ export class Project {
 
   /**
    * setup project
-   *
-   * @public
-   * @decorator `@bind`
    */
   @bind
   public async setup(): Promise<Project> {
@@ -214,29 +205,17 @@ export class Project {
     return this
   }
 
-  /**
-   * @public
-   * @decorator `@bind`
-   */
   @bind
   public projectPath(...file: Array<string>) {
     return join(this.dir, ...file)
   }
 
-  /**
-   * @public
-   * @decorator `@bind`
-   */
   @bind
   public async readJson(file: string) {
     const buffer = await fs.readFile(file)
     return json.parse(buffer.toString())
   }
 
-  /**
-   * @public
-   * @decorator `@bind`
-   */
   @bind
   public async setPackageJson() {
     const packageJson = await this.readJson(
@@ -246,21 +225,13 @@ export class Project {
     Object.assign(this, {packageJson})
   }
 
-  /**
-   * @public
-   * @decorator `@bind`
-   */
   @bind
   public async setManifest() {
     this.manifest = await this.readJson(
       this.projectPath(this.options.dist, `manifest.json`),
     )
   }
 
-  /**
-   * @public
-   * @decorator `@bind`
-   */
   @bind
   public async setAssets(): Promise<void> {
     await Promise.all(
@@ -277,10 +248,6 @@ export class Project {
     )
   }
 
-  /**
-   * @public
-   * @decorator `@bind`
-   */
   @bind
   public async setEntrypoints() {
     try {
@@ -292,10 +259,6 @@ export class Project {
     } catch (e) {}
   }
 
-  /**
-   * @public
-   * @decorator `@bind`
-   */
   @bind
   public async setModules() {
     try {

diff --git a/sources/@repo/yarn-plugin-bud/sources/command/base.command.ts b/sources/@repo/yarn-plugin-bud/sources/command/base.command.ts
@@ -34,7 +34,6 @@ export abstract class Command extends BaseCommand {
 
   /**
    * Get project configuration
-   * @decorator `@bind`
    */
   @bind
   public async getConfiguration() {
@@ -48,7 +47,6 @@ export abstract class Command extends BaseCommand {
 
   /**
    * Get project info
-   * @decorator `@bind`
    */
   @bind
   public async getProject() {

diff --git a/sources/@repo/yarn-plugin-bud/sources/command/dev.command.ts b/sources/@repo/yarn-plugin-bud/sources/command/dev.command.ts
@@ -27,9 +27,6 @@ export class Dev extends Command {
     ],
   }
 
-  /**
-   * @public
-   */
   public async execute() {
     await this.cli.run([`@bud`, `tsc`, `--force`])
 

diff --git a/sources/@repo/yarn-plugin-bud/sources/command/plugin.rebuild.command.ts b/sources/@repo/yarn-plugin-bud/sources/command/plugin.rebuild.command.ts
@@ -27,9 +27,6 @@ export class Plugin extends Command {
     ],
   }
 
-  /**
-   * @public
-   */
   public async execute() {
     await this.$([
       `yarn`,

diff --git a/sources/@repo/yarn-plugin-package/sources/command/base.command.ts b/sources/@repo/yarn-plugin-package/sources/command/base.command.ts
@@ -4,15 +4,12 @@ import {bind} from 'helpful-decorators'
 
 /**
  * Base class
- *
- * @internal
  */
 export abstract class Command extends BaseCommand {
   /**
    * Execute a series of tasks
    *
    * @param tasks - Any number of string commands
-   * @internal
    */
   @bind
   public async _$(...tasks: Array<string>): Promise<void> {
@@ -39,8 +36,6 @@ export abstract class Command extends BaseCommand {
    *
    * @remarks
    * Commands are executed in parallel
-   *
-   * @internal
    */
   @bind
   public async $(...tasks: Array<string>): Promise<void> {

diff --git a/sources/@repo/yarn-plugin-package/sources/command/get.command.ts b/sources/@repo/yarn-plugin-package/sources/command/get.command.ts
@@ -6,28 +6,20 @@ import {Command} from './base.command'
 
 /**
  * Base class
- *
- * @internal
  */
 export abstract class Get extends Command {
   /**
    * Command paths
-   *
-   * @internal
    */
   public static paths: CommandClass['paths'] = [[`package`, `get`]]
 
   /**
    * The property to get
-   *
-   * @internal
    */
   public property = Option.String()
 
   /**
    * Command execute
-   *
-   * @internal
    */
   public async execute() {
     const json = await fs.readJson(`${this.context.cwd}/package.json`)

diff --git a/sources/@repo/yarn-plugin-package/sources/command/set.command.ts b/sources/@repo/yarn-plugin-package/sources/command/set.command.ts
@@ -6,8 +6,6 @@ import {Command} from './base.command'
 
 /**
  * Base class
- *
- * @internal
  */
 export abstract class Set extends Command {
   public static paths: CommandClass['paths'] = [[`package`, `set`]]