stemmlerjs / simple-typescript-starter Goto Github PK

The most basic TypeScript starter I could think of

Home Page: https://khalilstemmler.com/blogs/typescript/node-starter-project/

JavaScript 17.97% TypeScript 70.11% Gherkin 11.92%

simple-typescript-starter's Introduction

🧰 Simple TypeScript Starter | 2024

We talk about a lot of advanced Node.js and TypeScript concepts on the blog, particularly focused around Domain-Driven Design and large-scale enterprise application patterns. However, I received a few emails from readers that were interested in seeing what a basic TypeScript starter project looks like. So I've put together just that.

Features

Minimal
TypeScript v4
Testing with Jest
Linting with Eslint and Prettier
Pre-commit hooks with Husky
VS Code debugger scripts
Local development with Nodemon

Scripts

`npm run start:dev`

Starts the application in development using nodemon and ts-node to do hot reloading.

`npm run start`

Starts the app in production by first building the project with npm run build, and then executing the compiled JavaScript at build/index.js.

`npm run build`

Builds the app at build, cleaning the folder first.

`npm run test`

Runs the jest tests once.

`npm run test:dev`

Run the jest tests in watch mode, waiting for file changes.

`npm run prettier-format`

Format your code.

`npm run prettier-watch`

Format your code in watch mode, waiting for file changes.

simple-typescript-starter's People

Contributors

Stargazers

Watchers

Forkers

maxistepanov deerhold 80xer hansschenker marcusps11 thiagodebastos aslanshemilov peterblockman enio-infotera samsoft00 nicolabello anjireddy-kata tchkirni jlopez90 ramasubbaiya jim-at-jibba drewngyen tomhanson jfernandez varghesetech the-skipper willowell stogo carantes w4-jake didaquis finnyfound leakon dushyg elenduuche stjordanis dennydharmawan furkantoprak bayuslari phillipplum rockcreation7 mscmnc lavisht22 hieu292 cyanfroste radiumskull emersonemc contexd jnslndqst romandulman joe3huang thomasbabuj lp-belliot fasanosalvatore aguerot rammazzoti2000 tupizz rajeevblr comlyboy fpineda3105 peanutqaq h4rdc0m atabcraft hharzer thanphisit eibay zmrfzn richie50 marcusalmeida mszpila siqueiraruela jonjazzy disco195 arpanoid alexandertrev leveratedev michaeleliot ismailrailgun21 kayode-adechinan matgsan jriewerts guifavere rkanadam jobran41 kotproger damrongsak whcc wleecarter 21sparker virtuoushub akinyeleolat github167 goonerdp chngyrnick anamale chanlevan hassanlatif solobat mlande fwmt ivanclabe ilumin italorfeitosa yasir5247 carlosziegler

simple-typescript-starter's Issues

missing testing aspect

Hola Khalil, first of all, thank you for your nice starter repo 👍!

Have you considered enhancing your repo with information about testing?

Should ALWAYS gitignore node_modules

Please add a VS Code debug file

Here is a VS Code Debug file in .vscode folder (${workspaceFolder}/.vscode or root dir + .vscode dir, or simple-typescript-starter-master/.vscode):

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "type": "node",
            "request": "launch",
            "name": "Launch Program",
            "program": "${workspaceFolder}/src/index.ts", // our main file
            "sourceMaps": true,
            "preLaunchTask": "npm: build",
            "outFiles": [
                "${workspaceFolder}/build/index.js"
            ]
        }
    ]
}

This works for Console.log(""), but try it for:

import fs from 'fs';

const text = fs.readFileSync("README.md", "utf8");
console.log(text);

and it will fail with

C:\Program Files\nodejs\node.exe .\src\index.ts
Debugger attached.
Waiting for the debugger to disconnect...
...\simple-typescript-starter-master\src\index.ts:1
import fs from 'fs';
^^^^^^

SyntaxError: Cannot use import statement outside a module
    at wrapSafe (internal/modules/cjs/loader.js:1072:16)

I am not a TS, Node and tricks person, but please add such a correct file, I would appreciate it.

Google Chrome DevTools

Hello ;)
I am trying to run source code using Google DevTools but have not been successful.

In package.json
"scripts": { "start:dev": "npx nodemon --inspect=127.0.0.1:9229 src/index.ts" }

Any help?

Package updates

Can the packages in repo be updated to the lastest versions ?
I get this long list of update with ncu

 @types/jest                       ^28.1.8  →  ^29.5.8
 @types/node                       ^18.6.1  →  ^20.9.0
 @typescript-eslint/eslint-plugin  ^5.31.0  →  ^6.10.0
 @typescript-eslint/parser         ^5.31.0  →  ^6.10.0
 eslint                            ^8.20.0  →  ^8.53.0
 eslint-config-prettier             ^8.5.0  →   ^9.0.0
 eslint-plugin-jest                ^26.6.0  →  ^27.6.0
 eslint-plugin-prettier             ^4.2.1  →   ^5.0.1
 husky                              ^8.0.1  →   ^8.0.3
 jest                              ^28.1.3  →  ^29.7.0
 nodemon                           ^2.0.19  →   ^3.0.1
 prettier                           ^2.7.1  →   ^3.0.3
 rimraf                             ^3.0.2  →   ^5.0.5
 ts-jest                           ^28.0.7  →  ^29.1.1
 typescript                         ^4.7.4  →   ^5.2.2

Thanks for the good writing.

I saw your blog. https://khalilstemmler.com/blogs/typescript/node-starter-project/

I am currently distributing TypeScript Express Starter as open source. However, I was solving a lint-related problem, and it seems to be a good resource.

We look forward to your good writing. :-D

Currently https://github.com/stemmlerjs/simple-typescript-starter/blob/master/.vscode/launch.json file is pointing to "${workspaceFolder}/dist/**/*.js" but the ts is being compiled into build folder. This results in error when debugging the code containing imports

stemmlerjs / simple-typescript-starter Goto Github PK

simple-typescript-starter's Introduction

🧰 Simple TypeScript Starter | 2024

Features

Scripts

npm run start:dev

npm run start

npm run build

npm run test

npm run test:dev

npm run prettier-format

npm run prettier-watch