Naomi's TypeScript Config

This package holds my TypeScript configuration for easy installation and syncing changes across projects.

Live Version

This package is currently published. View the npm page.

Installation

To install this package, run the following command:

npm i @nhcarrigan/typescript-config typescript

Compatibility

This package is compatible with TypeScript 5.

Usage

To use this package, add the following to your tsconfig.json file:

{
  "extends": "@nhcarrigan/typescript-config"
}

By default, the root directory is src and the output directory is prod. To override these:

{
  "extends": "@nhcarrigan/typescript-config",
  "compilerOptions": {
    "rootDir": "code",
    "outDir": "dist"
  }
}

Feedback and Bugs

If you have feedback or a bug report, please feel free to open a GitHub issue!

Contributing

If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our contributing guidelines first.

Code of Conduct

Before interacting with our community, please read our Code of Conduct.

License

This software is licensed under our global software license.

Copyright held by Naomi Carrigan.

Contact

We may be contacted through our Chat Server or via email at contact@nhcarrigan.com.