🚀A starter for any TypeScript project meant to be published on NPM🚀

ts-ci is a project starter like TSDX or typescript-starter but (arguably) better because:

• It's not a CLI tool, the automation happens with Github Actions.
  Update your package.json version number, push. Voila, your new version is published on NPM.
• It doesn't bundle your library into a single file so users can cherry-pick what they want to import from your lib, your modules will be tree shakable.
  E.g: import { aSpecificFunction } from "your-module/aSpecificFile"

How to use

• Click on
• The repo name you will choose will be used as a module name for NPM.
• Go to the repository Settings tab, then Secrets you will need to add a new secret: NPM_TOKEN, you NPM authorization token.
• To trigger publishing edit the package.json version field ( 0.0.0-> 0.0.1 for example) then push changes... that's all !
• Publish beta release by setting your version number to X.Y.Z-beta.T (example: 1.0.0-beta.32). You usually want to do that from a branch, it work as well! You just have to open a PR.

Features

This template automates the boring and tedious tasks of:

• Filling up the package.json
• Setting up Typescript.
• Testing on multiple Node version running on Ubuntu and Windows before publishing.
• Maintaining a CHANGELOG.
• Publishing on NPM and creating corresponding GitHub releases.

Besides, good stuff that comes with using this template:

• The dist/ directory is not tracked on the main branch.
• Shorter specific file import path.
  import {...} from "my_module/theFile" instead of the usual import {...} from "my_module/dist/theFile"
• ESlint and Prettier are automatically run against files staged for commit. (Optional, you can disable this feature)

Examples of project using this template

• keycloakify
• denoify
• tss-react
• EVT

FAQ

import * as fs from "fs";
import * as path from "path";

const str = fs.readFileSync(
    path.join(__dirname,"..", "package.json")
).toString("utf8");

import * as fs from "fs";
import * as path from "path";
import { getProjectRoot } from "./tools/getProjectRoot";

const str = fs.readFileSync(
    path.join(getProjectRoot(),"package.json")
).toString("utf8");

import * as fs from "fs";
import * as path from "path";

function getProjectRootRec(dirPath: string): string {
    if (fs.existsSync(path.join(dirPath, "package.json"))) {
        return dirPath;
    }
    return getProjectRootRec(path.join(dirPath, ".."));
}

let result: string | undefined = undefined;

export function getProjectRoot(): string {
    if (result !== undefined) {
        return result;
    }

    return (result = getProjectRootRec(__dirname));
}