Skip to content
This repository has been archived by the owner on Sep 30, 2022. It is now read-only.

Commit

Permalink
docs: fix module annotations in tools directory
Browse files Browse the repository at this point in the history
  • Loading branch information
unicornware committed Oct 1, 2021
1 parent 1661ebd commit 48f732b
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions tools/cli/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ import fixNodeModulePaths from '../helpers/fix-node-module-paths'
import { $name } from '../helpers/pkg-get'

/**
* @file Scripts - Build Workflow
* @module scripts/build
* @file CLI - Build Workflow
* @module tools/cli/build
*/

export type BuildOptions = {
Expand Down
4 changes: 2 additions & 2 deletions tools/cli/release.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import yargs from 'yargs/yargs'
import { $name, $version } from '../helpers/pkg-get'

/**
* @file Scripts - Release Workflow
* @module scripts/release
* @file CLI - Release Workflow
* @module tools/cli/release
*/

export type ReleaseOptions = {
Expand Down
4 changes: 2 additions & 2 deletions tools/helpers/exec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import type { ChildProcess } from 'child_process'
import sh from 'shelljs'

/**
* @file Script Utility - Shell Command Executor
* @module scripts/utils/exec
* @file Helpers - Shell Command Executor
* @module tools/helpers/exec
*/

/**
Expand Down
4 changes: 2 additions & 2 deletions tools/helpers/fix-node-module-paths.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import replace from 'replace-in-file'
import NODE_MODULES from './nm-string'

/**
* @file Scripts - Fix Node Module Import Paths
* @module scripts/fix-node-module-paths
* @file Helpers - Fix Node Module Import Paths
* @module tools/helpers/fix-node-module-paths
* @see https://github.com/adamreisnz/replace-in-file
*/

Expand Down
4 changes: 2 additions & 2 deletions tools/helpers/nm-string.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import join from 'lodash.join'

/**
* @file Scripts - 'node_modules'
* @module scripts/nm-string
* @file Helpers - 'node_modules'
* @module tools/helpers/nm-string
*/

/**
Expand Down
4 changes: 2 additions & 2 deletions tools/helpers/pkg-get.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import type { PackageJson } from 'read-pkg'
import read from 'read-pkg'

/**
* @file Script Utility - Get Package Data
* @module scripts/utils/pkg-get
* @file Helpers - Get Package Data
* @module tools/helpers/pkg-get
*/

/**
Expand Down

0 comments on commit 48f732b

Please sign in to comment.