1
0
Fork 0

feat: a template is born

main
James Spencer 2023-10-02 19:50:13 +01:00
commit 36d6c7d426
Signed by: james
SSH Key Fingerprint: SHA256:7tOVvkg3eVqn4GbEInHoSkEG96Cvqgvwx+VHUD9begc
9 changed files with 250 additions and 0 deletions

172
.gitignore vendored Normal file
View File

@ -0,0 +1,172 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
# Logs
logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
# Runtime data
pids
_.pid
_.seed
\*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
\*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/
# TypeScript cache
\*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional stylelint cache
.stylelintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
\*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache
# Next.js build output
.next
out
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# vuepress v2.x temp and cache directory
.temp
.cache
# Docusaurus cache and generated files
.docusaurus
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.\*
# IntelliJ based IDEs
.idea

6
.prettierignore Normal file
View File

@ -0,0 +1,6 @@
# Ignore artifacts:
build
coverage
node_modules
npm-debug.log
dist

7
.prettierrc.json Normal file
View File

@ -0,0 +1,7 @@
{
"tabWidth": 4,
"semi": true,
"singleQuote": true,
"useTabs": true,
"trailingComma": "none"
}

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# Typescript
A "simple" typescript starter.
Uses [bun](https://bun.sh) to manage dependencies and run the project, because well, I don't know. Code crimes.
## Install
```bash
bun install
```
## Run
```bash
bun start
```
## Linting
Linting is done with [Prettier](https://prettier.io/), [my editor](https://zed.dev/) is set up to run it on save so I've not added a linting script.

BIN
bun.lockb Executable file

Binary file not shown.

5
index.ts Normal file
View File

@ -0,0 +1,5 @@
function start(): void {
console.log('App started');
}
start();

13
package.json Normal file
View File

@ -0,0 +1,13 @@
{
"name": "typescript-template",
"module": "index.ts",
"type": "module",
"scripts": {
"start": "bun run index.ts"
},
"devDependencies": {
"bun-types": "^1.0.3",
"prettier": "^3.0.3",
"typescript": "^5.2.2"
}
}

21
tsconfig.json Normal file
View File

@ -0,0 +1,21 @@
{
"compilerOptions": {
"module": "esnext",
"target": "esnext",
"moduleResolution": "bundler",
"moduleDetection": "force",
"allowImportingTsExtensions": true,
"noEmit": true,
"composite": true,
"strict": true,
"downlevelIteration": true,
"skipLibCheck": true,
"jsx": "preserve",
"allowSyntheticDefaultImports": true,
"forceConsistentCasingInFileNames": true,
"allowJs": true,
"types": [
"bun-types" // add Bun global
]
}
}

6
types.d.ts vendored Normal file
View File

@ -0,0 +1,6 @@
/// <reference lib="dom" />
/// <reference lib="dom.iterable" />
/// <reference lib="esnext" />
// Necessary because bun
// https://bun.sh/docs/typescript#dom-types