• See CommonOptions interface.

Error - Throws an error if there is an issue creating or updating the file.

• See CommonOptions interface.

• Error - Throws an error if the tsconfig.json file cannot be read or updated.

• See AddTypesReferenceOptions interface.

Exit the process with code 1 on failure.

Add the postinstall script in your package.json file which will execute the script once your package get installed in an external project.

{
  // ...
  "files": [
    // ...,
    "my-scripts" // ensure folder is published to `npm`
  ],
  "scripts": {
    // ...
    "postinstall": "node my-scripts/ts-setup.ts"
  }
}

Then in your ts-setup.ts file simply import the script and execute it with a few options.

// my-scripts/ts-setup.ts
import { addTypesReference } from '@alessiofrittoli/node-scripts/postinstall'
import packageJson from '../package.json'

addTypesReference({
  name: packageJson.name,
  outputFile: `${packageJson.name}.d.ts`, // optional
})

Or you can statically pass a outputFile to add all your scoped packages in a single file.

// my-scripts/ts-setup.ts
import { addTypesReference } from '@alessiofrittoli/node-scripts/postinstall'
import packageJson from '../package.json'

addTypesReference({
  name: packageJson.name,
  outputFile: 'my-package-scope-env.d.ts',
})

// my-scripts/ts-setup.ts
import { addTypesReference } from '@alessiofrittoli/node-scripts/postinstall'
import packageJson from '../package.json'

addTypesReference({
  name: packageJson.name,
  types: [`${packageJson.name}/globals`, `${packageJson.name}/globals-2`],
  outputFile: `${packageJson.name}.d.ts`, // optional
})

1. Retrieve package.json:
   • Attempts to load and parse the package.json file.
   • Exits the process with code "1" if the file is unavailable or invalid.
   • Retrieve the version to use as fallback if no --version option has been provided.
2. Parse Options:
   • Retrieves CLI options using getProcessOptions().
   • Validates critical parameters such as version and access.
3. Prepare Git and Build:
   • Stashes any uncommitted changes with a stash name (pre-release).
   • Executes the npm run build or pnpm build command (if pnpm is globally installed).
   • Create the Git Tag as v{version}
   • Push the Git Tag the the specified origin or to the default Git Repository Remote.
4. Publish to npm (Optional):
   • Publishes the package using npm publish if the --npm flag is set.
5. Restore Stash:
   • Restores the stashed changes if any were saved during the process.
6. Verbose Logging:
   • Logs details of the release process if the --verbose flag is set.

Using function arguments

Add the release script in your package.json file so you can easly run from your terminal.

{
  // ...
  "scripts": {
    // ...
    "release": "node my-scripts/release.ts"
  }
}

Then in your release.ts file simply import the script and execute it.

⚠️ Remember to add this file to .npmignore so it won't be published within you package.

// my-scripts/release.ts
import { release } from '@alessiofrittoli/node-scripts/release'

release({
  verbose: true,
  npm: true,
  access: 'restricted',
})

Using CLI options

Add the release script in your package.json file so you can easly run from your terminal.

{
  // ...
  "scripts": {
    // ...
    "release": "node my-scripts/release.ts --verbose --npm --access restricted"
  }
}

Then in your release.ts file simply import the script and execute it.

⚠️ Remember to add this file to .npmignore so it won't be published within you package.

// my-scripts/release.ts
import { release } from '@alessiofrittoli/node-scripts/release'

release()