# typescript-starter-script

> A typescript starter script. I promise, just run the script.

Latest version **1.0.3** (published 2020-07-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install typescript-starter-script
pnpm add typescript-starter-script
yarn add typescript-starter-script
bun add typescript-starter-script
```

Provides the command `typescript-starter-script`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-07-27 |
| First published | 2020-02-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 31.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Adam Lind |
| Maintainers | naeralys |
| Keywords | typescript, starter |

## Links

- npm: https://www.npmjs.com/package/typescript-starter-script
- Repository: https://github.com/Naeralys/typescript-starter-script
- Homepage: https://github.com/Naeralys/typescript-starter-script#readme
- Issues: https://github.com/Naeralys/typescript-starter-script/issues
- npm.io page: https://npm.io/package/typescript-starter-script

## Dependencies (1)

- [inquirer](https://npm.io/package/inquirer.md) ^7.0.4

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2020-07-27
- 1.0.2 — 2020-02-21
- 1.0.1 — 2020-02-15
- 1.0.0 — 2020-02-15
- 0.0.1 — 2020-02-15

## README

# Typescript Starter Script
A typescript starter script. I promise, just run the script.

## Installation & Usage

1. Install the package with npm
```sh
npm install -g typescript-starter-script
```

2. Use the package to generate a new typescript project
```sh
typescript-starter-script
```

## What's inside?

How the script generates the project structure as well as the individual files.

    .
    ├── dist
    ├── src
    ├── test
    ├── .gitignore
    ├── package.json
    ├── tsconfig.json
    ├── tslint.json

1.  **`dist`**: This directory contains the generated javascript files, and will act as the executable product for deployment.
2.  **`src`**: This directory contains the typescript source files. This is where you put your source code, e.g develop your software.
3.  **`test`**: This directory contains the test files. It is only included if the "Include testing setup" flag is accepted when running the starter script. Put your test files here with a .test.ts extension, and run them with "npm test".
4.  **`.gitignore`**: A basic .gitignore. List any file here that you wish to not push to any repository, such as config files and .env files.
5.  **`package.json`**: Big boi node package file. Configure this file if you wish to add/change the default generated structure and content.
6.  **`tsconfig.json`**: Typescript compiler options. Add or remove any rules you wish the compiler to use. https://www.typescriptlang.org/docs/handbook/compiler-options.html Here's a full list of all the available features. Not using strict mode on default.
7.  **`tslint.json`**: Will help you use typescript in a structured way. 
https://palantir.github.io/tslint/rules/ For a full list of all the available features.

## Planned extensions
- Personal config file. Provide a .json config file to change the default settings for generating the files.
- [X] Generate project inside a subfolder and not in the current directory. (Currently in dev branch)
- Tests, with CI/CD
- Refactor dependency of the fs package. The FileGenerator should make use of dependency injection to use any file system package, and not directly import the fs package.

## Contribute

If you have an idea for a missing feature, just fork this repo and make a PR with your suggested implementation.

## Author

#### Adam Lind

## License
MIT

---
_Source: https://npm.io/package/typescript-starter-script · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._