@devshareacademy/tsconfig

Shared TypeScript config for my projects

Install

yarn add -DE @devshareacademy/tsconfig

Install Via GitHub NPM Packages

You can install this package from the GitHub NPM Package Repository. In order to do this, you must first authenticate with GitHub packages. You can read more about this process here: GitHub - Installing A GitHub Package.

yarn config set @lookio:registry https://npm.pkg.github.com/
echo "//npm.pkg.github.com/:_authToken=<github_personal_access_token>" > .npmrc
yarn add -DE @devshareacademy/tsconfig

Usage

tsconfig.json

{
  "extends": "@devshareacademy/tsconfig/tsconfig.json",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": [
    "**/*.ts"
  ]
}

When you are targeting a higher version of Node.js, check the relevant ECMAScript version and add it as target:

{
  "extends": "@devshareacademy/tsconfig/tsconfig.json",
  "compilerOptions": {
    "outDir": "dist",
    "target": "ES2021"
  },
  "include": [
    "**/*.ts"
  ]
}

When you are building a NPM package:

{
  "extends": "@devshareacademy/tsconfig",
  "compilerOptions": {
    "outDir": "dist",
    "declaration": true
  },
  "include": [
    "**/*.ts"
  ]
}

Publish New Version

# Authenticate with NPM Package Registry
npm login

# Run publish script
yarn publish:npm
yarn publish:github

Shared Configurations

• @devshareacademy/eslint-config: eslint-config
• @devshareacademy/tsconfig: tsconfig
• @devshareacademy/prettier-config: prettier-config