| Property | Type | Description |
| ------------ | -------- | ----------------------------------------------------------------------- |
| root | string | The root directory of the project which is installing your node module. |
| name | string | The name of your node module. |
| outputFile | string | The output file name. |

| Property | Type | Default | Description |
| ------------ | -------- | -------------------------- | ------------------------------------------------ |
| name | string | - | The project name currently executing the script. |
| outputFile | string | 'alessiofrittoli-env.d.ts' | The \*.d.ts output file name. |

Parameters

| Parameter | Type | Description |
| --------- | --------------- | ----------------------------------------------- |
| options | CommonOptions | Common options for the reference file creation. |

- See CommonOptions interface.

Returns

void

Throws

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

Parameters

| Parameter | Type | Description |
| --------- | --------------- | ----------------------------------------------- |
| options | CommonOptions | Common options for the reference file creation. |

- See CommonOptions interface.

Returns

void

Throws

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

Parameters

| Parameter | Type | Description |
| --------- | -------------------------- | ------------------------------------------- |
| options | AddTypesReferenceOptions | The options for adding the types reference. |

- See AddTypesReferenceOptions interface.

Returns

void

Error

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.

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

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

`ts
// path-to-my-scripts/ts-setup.js
const {
addTypesReference,
} = require("@alessiofrittoli/node-scripts/postinstall");
const project = require("../../package.json");

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

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

`ts
// path-to-my-scripts/ts-setup.js
const {
addTypesReference,
} = require("@alessiofrittoli/node-scripts/postinstall");
const project = require("../../package.json");

addTypesReference({
name: project.name,
outputFile: "my-package-scope-env.d.ts",
});
`

| Argument | Type | Default | Description |
| --------- | -------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------- |
| version | string | --version process option or package.json. | The version to release. |
| | | | Retrieved from --version process option or package.json if omitted. |
| build | string | 'build' | A custom build command that will build your project before publish. |
| | | | Retrieved from --build process option or fallback to build if omitted. |
| verbose | boolean | false | Enables detailed logging. |
| | | | Retrieved from --verbose process option or fallback to false if omitted. |
| origin | string | 'origin' | The Git origin name used for pushing version tags. |
| | | | Retrieved from --origin or --o process option or fallback to origin if omitted. |
| npm | boolean | false | Indicates whether to publish the package to npm. |
| | | | Retrieved from --npm process option or fallback to false if omitted. |
| access | public\|restricted | 'public' | Sets npm package access level. |
| | | | Retrieved from --access process option or fallback to public if omitted. |

| Option | Type | Default | Description |
| ---------------- | -------------------- | ----------------------- | ------------------------------------------------------------------- |
| --version | string | Value from package.json | The version to release. Retrieved from package.json if omitted. |
| | | | Retrieved from package.json if omitted. |
| --build | string | build | A custom build command that will build your project before publish. |
| --verbose | boolean | false | Enables detailed logging. |
| --origin, -o | string | 'origin' | The Git origin name used for pushing version tags. |
| --npm | boolean | false | Indicates whether to publish the package to npm. |
| --access | public\|restricted | 'public' | Sets npm package access level. |



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.

`json
{
// ...
"scripts": {
// ...
"release": "node path-to-my-scripts/release.js"
}
}
`

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

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

`ts
// path-to-my-scripts/release.js
require("@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.

`json
{
// ...
"scripts": {
// ...
"release": "node path-to-my-scripts/release.js --verbose --npm --access restricted"
}
}
`

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

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

`ts
// path-to-my-scripts/release.js
require("@alessiofrittoli/node-scripts/release").release();
`