Initial commit
This commit is contained in:
		
							
								
								
									
										1
									
								
								.devcontainer.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								.devcontainer.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1 @@
 | 
			
		||||
{"image":"mcr.microsoft.com/devcontainers/javascript-node","build":{}}
 | 
			
		||||
							
								
								
									
										180
									
								
								.drone.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										180
									
								
								.drone.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,180 @@
 | 
			
		||||
---
 | 
			
		||||
kind: pipeline
 | 
			
		||||
type: docker
 | 
			
		||||
name: pr
 | 
			
		||||
trigger:
 | 
			
		||||
  event:
 | 
			
		||||
    - pull_request
 | 
			
		||||
 | 
			
		||||
steps:
 | 
			
		||||
  - name: restore-cache
 | 
			
		||||
    image: drillster/drone-volume-cache
 | 
			
		||||
    settings:
 | 
			
		||||
      restore: true
 | 
			
		||||
      mount:
 | 
			
		||||
        - ./node_modules
 | 
			
		||||
    volumes:
 | 
			
		||||
      - name: cache
 | 
			
		||||
        path: /cache
 | 
			
		||||
  - name: dependencies
 | 
			
		||||
    image: node:lts-alpine
 | 
			
		||||
    environment:
 | 
			
		||||
      CI: true
 | 
			
		||||
    commands: 
 | 
			
		||||
      - npm install
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - restore-cache
 | 
			
		||||
  - name: tests
 | 
			
		||||
    image: node:lts-alpine
 | 
			
		||||
    environment:
 | 
			
		||||
      CI: true
 | 
			
		||||
    commands:
 | 
			
		||||
      - npm test
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - dependencies
 | 
			
		||||
  - name: format
 | 
			
		||||
    image: node:lts-alpine
 | 
			
		||||
    environment:
 | 
			
		||||
      CI: true
 | 
			
		||||
    commands:
 | 
			
		||||
      - npm run format
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - tests
 | 
			
		||||
  - name: push-changes
 | 
			
		||||
    image: appleboy/drone-git-push
 | 
			
		||||
    environment:
 | 
			
		||||
      CI: true
 | 
			
		||||
      CI_USERNAME:
 | 
			
		||||
        from_secret: ci_username
 | 
			
		||||
      CI_PASSWORD:
 | 
			
		||||
        from_secret: ci_password
 | 
			
		||||
      GIT_COMMITTER_NAME:
 | 
			
		||||
        from_secret: ci_username
 | 
			
		||||
      GIT_COMMITTER_EMAIL:
 | 
			
		||||
        from_secret: ci_email
 | 
			
		||||
      PLUGIN_AUTHOR_NAME:
 | 
			
		||||
        from_secret: ci_username
 | 
			
		||||
      PLUGIN_AUTHOR_EMAIL:
 | 
			
		||||
        from_secret: ci_email
 | 
			
		||||
      PLUGIN_USERNAME:
 | 
			
		||||
        from_secret: ci_username
 | 
			
		||||
      PLUGIN_PASSWORD:
 | 
			
		||||
        from_secret: ci_password
 | 
			
		||||
    settings:
 | 
			
		||||
      branch: "${DRONE_SOURCE_BRANCH}"
 | 
			
		||||
      remote: https://${CI_USERNAME}:${CI_PASSWORD}@git.astrogd.cloud/internal/template-typescript.git
 | 
			
		||||
      force: false
 | 
			
		||||
      commit: true
 | 
			
		||||
      commit_message: "[CI] Ensure code style on ${DRONE_COMMIT_SHA:0:7}"
 | 
			
		||||
      author_name: "${GIT_COMMITTER_NAME}"
 | 
			
		||||
      author_email: "${GIT_COMMITTER_EMAIL}"
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - format
 | 
			
		||||
  - name: rebuild-cache
 | 
			
		||||
    image: drillster/drone-volume-cache
 | 
			
		||||
    settings:
 | 
			
		||||
      rebuild: true
 | 
			
		||||
      mount:
 | 
			
		||||
        - ./node_modules
 | 
			
		||||
    volumes:
 | 
			
		||||
      - name: cache
 | 
			
		||||
        path: /cache
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - dependencies
 | 
			
		||||
 | 
			
		||||
volumes:
 | 
			
		||||
- name: cache
 | 
			
		||||
  host:
 | 
			
		||||
    path: /tmp/drone/ci/cache
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
kind: pipeline
 | 
			
		||||
type: docker
 | 
			
		||||
name: push
 | 
			
		||||
trigger:
 | 
			
		||||
  event:
 | 
			
		||||
    - push
 | 
			
		||||
  branch:
 | 
			
		||||
    - main
 | 
			
		||||
    - dev
 | 
			
		||||
 | 
			
		||||
steps:
 | 
			
		||||
  - name: restore-cache
 | 
			
		||||
    image: drillster/drone-volume-cache
 | 
			
		||||
    settings:
 | 
			
		||||
      restore: true
 | 
			
		||||
      mount:
 | 
			
		||||
        - ./node_modules
 | 
			
		||||
    volumes:
 | 
			
		||||
      - name: cache
 | 
			
		||||
        path: /cache
 | 
			
		||||
  - name: dependencies
 | 
			
		||||
    image: node:lts-alpine
 | 
			
		||||
    environment:
 | 
			
		||||
      CI: true
 | 
			
		||||
    commands: 
 | 
			
		||||
      - npm install
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - restore-cache
 | 
			
		||||
  - name: tests
 | 
			
		||||
    image: node:lts-alpine
 | 
			
		||||
    environment:
 | 
			
		||||
      CI: true
 | 
			
		||||
    commands:
 | 
			
		||||
      - npm test
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - dependencies
 | 
			
		||||
  - name: format
 | 
			
		||||
    image: node:lts-alpine
 | 
			
		||||
    environment:
 | 
			
		||||
      CI: true
 | 
			
		||||
    commands:
 | 
			
		||||
      - npm run format
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - tests
 | 
			
		||||
  - name: push-changes
 | 
			
		||||
    image: appleboy/drone-git-push
 | 
			
		||||
    environment:
 | 
			
		||||
      CI: true
 | 
			
		||||
      CI_USERNAME:
 | 
			
		||||
        from_secret: ci_username
 | 
			
		||||
      CI_PASSWORD:
 | 
			
		||||
        from_secret: ci_password
 | 
			
		||||
      GIT_COMMITTER_NAME:
 | 
			
		||||
        from_secret: ci_username
 | 
			
		||||
      GIT_COMMITTER_EMAIL:
 | 
			
		||||
        from_secret: ci_email
 | 
			
		||||
      PLUGIN_AUTHOR_NAME:
 | 
			
		||||
        from_secret: ci_username
 | 
			
		||||
      PLUGIN_AUTHOR_EMAIL:
 | 
			
		||||
        from_secret: ci_email
 | 
			
		||||
      PLUGIN_USERNAME:
 | 
			
		||||
        from_secret: ci_username
 | 
			
		||||
      PLUGIN_PASSWORD:
 | 
			
		||||
        from_secret: ci_password
 | 
			
		||||
    settings:
 | 
			
		||||
      branch: "${DRONE_SOURCE_BRANCH}"
 | 
			
		||||
      remote: https://${CI_USERNAME}:${CI_PASSWORD}@git.astrogd.cloud/internal/template-typescript.git
 | 
			
		||||
      force: false
 | 
			
		||||
      commit: true
 | 
			
		||||
      commit_message: "[CI] Ensure code style on ${DRONE_COMMIT_SHA:0:7}"
 | 
			
		||||
      author_name: "${GIT_COMMITTER_NAME}"
 | 
			
		||||
      author_email: "${GIT_COMMITTER_EMAIL}"
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - format
 | 
			
		||||
  - name: rebuild-cache
 | 
			
		||||
    image: drillster/drone-volume-cache
 | 
			
		||||
    settings:
 | 
			
		||||
      rebuild: true
 | 
			
		||||
      mount:
 | 
			
		||||
        - ./node_modules
 | 
			
		||||
    volumes:
 | 
			
		||||
      - name: cache
 | 
			
		||||
        path: /cache
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - dependencies
 | 
			
		||||
 | 
			
		||||
volumes:
 | 
			
		||||
- name: cache
 | 
			
		||||
  host:
 | 
			
		||||
    path: /tmp/drone/ci/cache
 | 
			
		||||
							
								
								
									
										4
									
								
								.env.template
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										4
									
								
								.env.template
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,4 @@
 | 
			
		||||
DB_USER=user
 | 
			
		||||
DB_PASS=PASSWORD
 | 
			
		||||
DB_HOST=localhost
 | 
			
		||||
DB_NAME=template
 | 
			
		||||
							
								
								
									
										5
									
								
								.eslintignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								.eslintignore
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,5 @@
 | 
			
		||||
dist
 | 
			
		||||
node_modules
 | 
			
		||||
.drone.yml
 | 
			
		||||
data
 | 
			
		||||
userdata
 | 
			
		||||
							
								
								
									
										19
									
								
								.eslintrc.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								.eslintrc.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,19 @@
 | 
			
		||||
{
 | 
			
		||||
    "env": {
 | 
			
		||||
        "es2021": true,
 | 
			
		||||
        "node": true
 | 
			
		||||
    },
 | 
			
		||||
    "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
 | 
			
		||||
    "overrides": [],
 | 
			
		||||
    "parser": "@typescript-eslint/parser",
 | 
			
		||||
    "parserOptions": {
 | 
			
		||||
        "ecmaVersion": "latest",
 | 
			
		||||
        "sourceType": "module"
 | 
			
		||||
    },
 | 
			
		||||
    "plugins": ["@typescript-eslint"],
 | 
			
		||||
    "rules": {
 | 
			
		||||
        "indent": ["error", 4],
 | 
			
		||||
        "linebreak-style": ["error", "unix"],
 | 
			
		||||
        "quotes": ["error", "double"]
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										137
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										137
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,137 @@
 | 
			
		||||
# ---> Node
 | 
			
		||||
# 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.*
 | 
			
		||||
 | 
			
		||||
# Docker data directory
 | 
			
		||||
data
 | 
			
		||||
 | 
			
		||||
# AstrOGD Userdata directory
 | 
			
		||||
userdata
 | 
			
		||||
							
								
								
									
										14
									
								
								.npmignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								.npmignore
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,14 @@
 | 
			
		||||
*.ts
 | 
			
		||||
!*.d.ts
 | 
			
		||||
tsconfig.json
 | 
			
		||||
.prettierrc.json
 | 
			
		||||
.prettierignore
 | 
			
		||||
.eslintrc.json
 | 
			
		||||
.eslintignore
 | 
			
		||||
.drone.yml
 | 
			
		||||
coverage
 | 
			
		||||
.env
 | 
			
		||||
Dockerfile
 | 
			
		||||
.devcontainer.json
 | 
			
		||||
data
 | 
			
		||||
userdata
 | 
			
		||||
							
								
								
									
										4
									
								
								.npmrc
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										4
									
								
								.npmrc
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,4 @@
 | 
			
		||||
@astrogd:registry=https://git.astrogd.cloud/api/packages/packages/npm/
 | 
			
		||||
//git.astrogd.cloud/api/packages/packages/npm/:_authToken=${NPM_TOKEN}
 | 
			
		||||
@internal:registry=https://git.astrogd.cloud/api/packages/internal/npm/
 | 
			
		||||
//git.astrogd.cloud/api/packages/internal/npm/:_authToken=${NPM_TOKEN}
 | 
			
		||||
							
								
								
									
										8
									
								
								.prettierignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								.prettierignore
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
.gitignore
 | 
			
		||||
.npmrc
 | 
			
		||||
coverage
 | 
			
		||||
node_modules
 | 
			
		||||
.drone.yml
 | 
			
		||||
.devcontainer.json
 | 
			
		||||
data
 | 
			
		||||
userdata
 | 
			
		||||
							
								
								
									
										13
									
								
								.prettierrc.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								.prettierrc.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,13 @@
 | 
			
		||||
{
 | 
			
		||||
    "printWidth": 150,
 | 
			
		||||
    "tabWidth": 4,
 | 
			
		||||
    "semi": true,
 | 
			
		||||
    "singleQuote": false,
 | 
			
		||||
    "quoteProps": "consistent",
 | 
			
		||||
    "jsxSingleQuote": false,
 | 
			
		||||
    "trailingComma": "es5",
 | 
			
		||||
    "bracketSpacing": true,
 | 
			
		||||
    "bracketSameLine": false,
 | 
			
		||||
    "arrowParens": "always",
 | 
			
		||||
    "singleAttributePerLine": false
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										14
									
								
								Dockerfile
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								Dockerfile
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,14 @@
 | 
			
		||||
FROM node:lts-alpine AS builder
 | 
			
		||||
ENV NODE_ENV=production
 | 
			
		||||
# RUN apk add --no-cache python3 make g++
 | 
			
		||||
COPY dist/package*.json ./
 | 
			
		||||
RUN npm install --omit=dev
 | 
			
		||||
 | 
			
		||||
FROM node:lts-alpine AS app
 | 
			
		||||
WORKDIR /usr/src/app
 | 
			
		||||
ENV NODE_ENV=production
 | 
			
		||||
COPY --from=builder node_modules ./node_modules
 | 
			
		||||
COPY dist/ .
 | 
			
		||||
VOLUME [ "/usr/src/app/save" ]
 | 
			
		||||
EXPOSE 80
 | 
			
		||||
CMD ["node", "--enable-source-maps", "index.js"]
 | 
			
		||||
							
								
								
									
										3
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,3 @@
 | 
			
		||||
# template-typescript
 | 
			
		||||
 | 
			
		||||
Default template for typescript projects
 | 
			
		||||
							
								
								
									
										33
									
								
								docker-compose.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								docker-compose.yml
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,33 @@
 | 
			
		||||
version: "3.9"
 | 
			
		||||
services:
 | 
			
		||||
  app:
 | 
			
		||||
    image: astrogd/template-typescript:latest
 | 
			
		||||
    build: ./
 | 
			
		||||
    ports:
 | 
			
		||||
      - 80:80
 | 
			
		||||
    tty: true
 | 
			
		||||
    stdin_open: true
 | 
			
		||||
    depends_on:
 | 
			
		||||
      - db
 | 
			
		||||
    restart: unless-stopped
 | 
			
		||||
    environment:
 | 
			
		||||
      - TOKEN=$TOKEN
 | 
			
		||||
      - DB_HOST=database
 | 
			
		||||
      - DB_USERNAME=$DB_USER
 | 
			
		||||
      - DB_PASSWORD=$DB_PASS
 | 
			
		||||
      - DB_DATABASE=$DB_NAME
 | 
			
		||||
    volumes:
 | 
			
		||||
      - ./data/app:/usr/src/app/save
 | 
			
		||||
  db:
 | 
			
		||||
    image: postgres:latest
 | 
			
		||||
    restart: unless-stopped
 | 
			
		||||
    ports:
 | 
			
		||||
      - 5432:5432
 | 
			
		||||
    environment:
 | 
			
		||||
      - POSTGRES_USER=$DB_USER
 | 
			
		||||
      - POSTGRES_PASSWORD=$DB_PASS
 | 
			
		||||
      - POSTGRES_DB=$DB_NAME
 | 
			
		||||
    expose: 
 | 
			
		||||
      - 5432
 | 
			
		||||
    volumes:
 | 
			
		||||
      - ./data/db:/var/lib/postgresql/data
 | 
			
		||||
							
								
								
									
										17
									
								
								index.test.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										17
									
								
								index.test.ts
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,17 @@
 | 
			
		||||
jest.spyOn(console, "log");
 | 
			
		||||
 | 
			
		||||
describe("index", () => {
 | 
			
		||||
    beforeEach(() => {
 | 
			
		||||
        jest.clearAllMocks();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it("should log hello world", async () => {
 | 
			
		||||
        (console.log as jest.MockedFn<typeof console.log>).mockImplementation(() => {
 | 
			
		||||
            return;
 | 
			
		||||
        });
 | 
			
		||||
        await import("./index");
 | 
			
		||||
 | 
			
		||||
        expect(console.log).toHaveBeenCalledTimes(1);
 | 
			
		||||
        expect(console.log).toHaveBeenLastCalledWith("Hello world!");
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
							
								
								
									
										11
									
								
								index.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								index.ts
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,11 @@
 | 
			
		||||
import { initPromise } from "./src/db/dataSource";
 | 
			
		||||
 | 
			
		||||
async function run() {
 | 
			
		||||
    await initPromise;
 | 
			
		||||
 | 
			
		||||
    console.log("Hello world");
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
run();
 | 
			
		||||
 | 
			
		||||
export {};
 | 
			
		||||
							
								
								
									
										5840
									
								
								package-lock.json
									
									
									
										generated
									
									
									
										Normal file
									
								
							
							
						
						
									
										5840
									
								
								package-lock.json
									
									
									
										generated
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										86
									
								
								package.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										86
									
								
								package.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,86 @@
 | 
			
		||||
{
 | 
			
		||||
    "name": "@internal/template-typescript",
 | 
			
		||||
    "version": "1.0.0-dev.1",
 | 
			
		||||
    "description": "Just another cool typescript project",
 | 
			
		||||
    "main": "dist/index.js",
 | 
			
		||||
    "types": "dist/types/",
 | 
			
		||||
    "directories": {
 | 
			
		||||
        "bin": "dist/bin/"
 | 
			
		||||
    },
 | 
			
		||||
    "scripts": {
 | 
			
		||||
        "start": "npm run build && node --enable-source-maps .",
 | 
			
		||||
        "test": "npm run build && npm run test:jest && npm run test:style",
 | 
			
		||||
        "format": "prettier --write .",
 | 
			
		||||
        "build": "tsc",
 | 
			
		||||
        "deploy:npm": "npm publish",
 | 
			
		||||
        "deploy:docker": "npm run prepack && docker build -t astrogd/template-typescript:latest .",
 | 
			
		||||
        "version:dev": "npm version prerelease --preid dev --no-commit-hooks --no-git-tag-version",
 | 
			
		||||
        "version:patch": "npm version prepatch --preid dev --no-commit-hooks --no-git-tag-version",
 | 
			
		||||
        "version:minor": "npm version preminor --preid dev --no-commit-hooks --no-git-tag-version",
 | 
			
		||||
        "version:major": "npm version premajor --preid dev --no-commit-hooks --no-git-tag-version",
 | 
			
		||||
        "version:release": "npm version patch --no-commit-hooks --no-git-tag-version",
 | 
			
		||||
        "ci:sign": "drone sign internal/template-typescript --save",
 | 
			
		||||
        "test:jest": "jest --coverage",
 | 
			
		||||
        "test:style": "eslint **.ts --fix",
 | 
			
		||||
        "postinstall": "jest --clearCache",
 | 
			
		||||
        "prepack": "npx rimraf dist && npm run test && npm run build",
 | 
			
		||||
        "migration:create": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate -d src/db/dataSource.ts -p src/db/migrations/data",
 | 
			
		||||
        "migration:run": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:run -d src/db/dataSource.ts",
 | 
			
		||||
        "migration:revert": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:revert -d src/db/dataSource.ts",
 | 
			
		||||
        "migration:show": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:show -d src/db/dataSource.ts",
 | 
			
		||||
        "migration:check": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate --check -d src/db/dataSource.ts src/db/migrations/data"
 | 
			
		||||
    },
 | 
			
		||||
    "author": "AstroGD Lukas Weber <hello@astrogd.eu> (https://www.astrogd.eu/)",
 | 
			
		||||
    "license": "UNLICENSED",
 | 
			
		||||
    "repository": {
 | 
			
		||||
        "type": "git",
 | 
			
		||||
        "url": "https://git.astrogd.cloud/internal/template-typescript.git"
 | 
			
		||||
    },
 | 
			
		||||
    "jest": {
 | 
			
		||||
        "preset": "ts-jest",
 | 
			
		||||
        "testEnvironment": "node",
 | 
			
		||||
        "coverageThreshold": {
 | 
			
		||||
            "global": {
 | 
			
		||||
                "branches": 80,
 | 
			
		||||
                "functions": 80,
 | 
			
		||||
                "lines": 80,
 | 
			
		||||
                "statements": -20
 | 
			
		||||
            },
 | 
			
		||||
            "**/*.{ts,tsx}": {
 | 
			
		||||
                "branches": 95,
 | 
			
		||||
                "functions": 95,
 | 
			
		||||
                "lines": 95,
 | 
			
		||||
                "statements": -5
 | 
			
		||||
            }
 | 
			
		||||
        },
 | 
			
		||||
        "collectCoverageFrom": [
 | 
			
		||||
            "**/*.ts",
 | 
			
		||||
            "!**/*.d.ts",
 | 
			
		||||
            "!**/node_modules /**",
 | 
			
		||||
            "!**/coverage /**"
 | 
			
		||||
        ],
 | 
			
		||||
        "testPathIgnorePatterns": [
 | 
			
		||||
            "/node_modules/",
 | 
			
		||||
            "/*.d.ts"
 | 
			
		||||
        ]
 | 
			
		||||
    },
 | 
			
		||||
    "devDependencies": {
 | 
			
		||||
        "@types/jest": "^29.4.0",
 | 
			
		||||
        "@types/node": "^18.16.19",
 | 
			
		||||
        "@typescript-eslint/eslint-plugin": "^6.7.0",
 | 
			
		||||
        "@typescript-eslint/parser": "^6.7.0",
 | 
			
		||||
        "eslint": "^8.33.0",
 | 
			
		||||
        "jest": "^29.4.2",
 | 
			
		||||
        "prettier": "^3.0.0",
 | 
			
		||||
        "rimraf": "^5.0.1",
 | 
			
		||||
        "ts-jest": "^29.0.5",
 | 
			
		||||
        "ts-node": "^10.9.1",
 | 
			
		||||
        "typescript": "^5.1.6"
 | 
			
		||||
    },
 | 
			
		||||
    "dependencies": {
 | 
			
		||||
        "dotenv": "^16.3.1",
 | 
			
		||||
        "dotenv-expand": "^10.0.0",
 | 
			
		||||
        "pg": "^8.11.1",
 | 
			
		||||
        "typeorm": "^0.3.17"
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										57
									
								
								src/db/dataSource.test.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										57
									
								
								src/db/dataSource.test.ts
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,57 @@
 | 
			
		||||
import { randomUUID } from "crypto";
 | 
			
		||||
 | 
			
		||||
jest.mock("typeorm");
 | 
			
		||||
 | 
			
		||||
describe("src/db:dataSource", () => {    
 | 
			
		||||
    beforeEach(() => {
 | 
			
		||||
        jest.resetModules();
 | 
			
		||||
        jest.clearAllMocks();
 | 
			
		||||
 | 
			
		||||
        process.env["DB_HOST"] = randomUUID();
 | 
			
		||||
        process.env["DB_USER"] = randomUUID();
 | 
			
		||||
        process.env["DB_PASS"] = randomUUID();
 | 
			
		||||
        process.env["DB_NAME"] = randomUUID();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it("throws an error if an environment variable is missing", async () => {
 | 
			
		||||
        delete process.env["DB_HOST"];
 | 
			
		||||
        process.env["DB_USER"] = randomUUID();
 | 
			
		||||
        process.env["DB_PASS"] = randomUUID();
 | 
			
		||||
        process.env["DB_NAME"] = randomUUID();
 | 
			
		||||
 | 
			
		||||
        await expect(async () => await import("./dataSource")).rejects.toThrowError(ReferenceError);
 | 
			
		||||
 | 
			
		||||
        jest.resetModules();
 | 
			
		||||
 | 
			
		||||
        process.env["DB_HOST"] = randomUUID();
 | 
			
		||||
        delete process.env["DB_USER"];
 | 
			
		||||
 | 
			
		||||
        await expect(async () => await import("./dataSource")).rejects.toThrowError(ReferenceError);
 | 
			
		||||
 | 
			
		||||
        jest.resetModules();
 | 
			
		||||
 | 
			
		||||
        process.env["DB_USER"] = randomUUID();
 | 
			
		||||
        delete process.env["DB_PASS"];
 | 
			
		||||
 | 
			
		||||
        await expect(async () => await import("./dataSource")).rejects.toThrowError(ReferenceError);
 | 
			
		||||
 | 
			
		||||
        jest.resetModules();
 | 
			
		||||
 | 
			
		||||
        process.env["DB_PASS"] = randomUUID();
 | 
			
		||||
        delete process.env["DB_NAME"];
 | 
			
		||||
 | 
			
		||||
        await expect(async () => await import("./dataSource")).rejects.toThrowError(ReferenceError);
 | 
			
		||||
 | 
			
		||||
        jest.resetModules();
 | 
			
		||||
 | 
			
		||||
        process.env["DB_NAME"] = randomUUID();
 | 
			
		||||
 | 
			
		||||
        expect(async () => await import("./dataSource")).not.toThrow();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it("exports an initialized dataSource", async () => {
 | 
			
		||||
        const dut = (await import("./dataSource")).default;
 | 
			
		||||
 | 
			
		||||
        expect(dut.initialize).toHaveBeenCalled();
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
							
								
								
									
										37
									
								
								src/db/dataSource.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										37
									
								
								src/db/dataSource.ts
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,37 @@
 | 
			
		||||
import path from "path";
 | 
			
		||||
import { DataSource } from "typeorm";
 | 
			
		||||
import { config } from "dotenv";
 | 
			
		||||
import dotenvExpand from "dotenv-expand";
 | 
			
		||||
 | 
			
		||||
const env = config();
 | 
			
		||||
dotenvExpand.expand(env);
 | 
			
		||||
 | 
			
		||||
const host = process.env["DB_HOST"];
 | 
			
		||||
const username = process.env["DB_USER"];
 | 
			
		||||
const password = process.env["DB_PASS"];
 | 
			
		||||
const database = process.env["DB_NAME"];
 | 
			
		||||
 | 
			
		||||
if (!host) throw new ReferenceError("Environment variable DB_HOST is missing");
 | 
			
		||||
if (!password) throw new ReferenceError("Environment variable DB_PASS is missing");
 | 
			
		||||
if (!username) throw new ReferenceError("Environment variable DB_USER is missing");
 | 
			
		||||
if (!database) throw new ReferenceError("Environment variable DB_NAME is missing");
 | 
			
		||||
 | 
			
		||||
const dataSource = new DataSource({
 | 
			
		||||
    type: "postgres",
 | 
			
		||||
    host: host,
 | 
			
		||||
    port: 5432,
 | 
			
		||||
    username: username,
 | 
			
		||||
    password: password,
 | 
			
		||||
    database: database,
 | 
			
		||||
    migrationsRun: true,
 | 
			
		||||
    migrations: [path.join(__dirname, "/migrations/*")],
 | 
			
		||||
    entities: [],
 | 
			
		||||
    migrationsTransactionMode: "each",
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
const initPromise = dataSource.initialize();
 | 
			
		||||
 | 
			
		||||
export default dataSource;
 | 
			
		||||
export {
 | 
			
		||||
    initPromise
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										103
									
								
								tsconfig.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										103
									
								
								tsconfig.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,103 @@
 | 
			
		||||
{
 | 
			
		||||
    "compilerOptions": {
 | 
			
		||||
        /* Visit https://aka.ms/tsconfig to read more about this file */
 | 
			
		||||
 | 
			
		||||
        /* Projects */
 | 
			
		||||
        // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
 | 
			
		||||
        // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
 | 
			
		||||
        // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
 | 
			
		||||
        // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
 | 
			
		||||
        // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
 | 
			
		||||
        // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 | 
			
		||||
 | 
			
		||||
        /* Language and Environment */
 | 
			
		||||
        "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
 | 
			
		||||
        // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
 | 
			
		||||
        // "jsx": "preserve",                                /* Specify what JSX code is generated. */
 | 
			
		||||
        "experimentalDecorators": true /* Enable experimental support for TC39 stage 2 draft decorators. */,
 | 
			
		||||
        "emitDecoratorMetadata": true /* Emit design-type metadata for decorated declarations in source files. */,
 | 
			
		||||
        // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
 | 
			
		||||
        // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
 | 
			
		||||
        // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
 | 
			
		||||
        // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
 | 
			
		||||
        // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
 | 
			
		||||
        // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
 | 
			
		||||
        // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 | 
			
		||||
 | 
			
		||||
        /* Modules */
 | 
			
		||||
        "module": "commonjs" /* Specify what module code is generated. */,
 | 
			
		||||
        // "rootDir": "./",                                  /* Specify the root folder within your source files. */
 | 
			
		||||
        "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
 | 
			
		||||
        // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
 | 
			
		||||
        // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
 | 
			
		||||
        // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
 | 
			
		||||
        // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
 | 
			
		||||
        // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
 | 
			
		||||
        // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
 | 
			
		||||
        // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
 | 
			
		||||
        "resolveJsonModule": true /* Enable importing .json files. */,
 | 
			
		||||
        // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
 | 
			
		||||
 | 
			
		||||
        /* JavaScript Support */
 | 
			
		||||
        // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
 | 
			
		||||
        // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
 | 
			
		||||
        // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
 | 
			
		||||
 | 
			
		||||
        /* Emit */
 | 
			
		||||
        "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
 | 
			
		||||
        "declarationMap": true /* Create sourcemaps for d.ts files. */,
 | 
			
		||||
        // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
 | 
			
		||||
        // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
 | 
			
		||||
        // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
 | 
			
		||||
        "outDir": "./dist" /* Specify an output folder for all emitted files. */,
 | 
			
		||||
        // "removeComments": true,                           /* Disable emitting comments. */
 | 
			
		||||
        // "noEmit": true,                                   /* Disable emitting files from a compilation. */
 | 
			
		||||
        // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
 | 
			
		||||
        // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
 | 
			
		||||
        // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
 | 
			
		||||
        // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
 | 
			
		||||
        // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
 | 
			
		||||
        "inlineSourceMap": true /* Include sourcemap files inside the emitted JavaScript. */,
 | 
			
		||||
        "inlineSources": true /* Include source code in the sourcemaps inside the emitted JavaScript. */,
 | 
			
		||||
        // "emitBOM": true /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */,
 | 
			
		||||
        // "newLine": "crlf",                                /* Set the newline character for emitting files. */
 | 
			
		||||
        // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
 | 
			
		||||
        // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
 | 
			
		||||
        // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
 | 
			
		||||
        // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
 | 
			
		||||
        "declarationDir": "./dist/types" /* Specify the output directory for generated declaration files. */,
 | 
			
		||||
        // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
 | 
			
		||||
 | 
			
		||||
        /* Interop Constraints */
 | 
			
		||||
        // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
 | 
			
		||||
        // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
 | 
			
		||||
        "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
 | 
			
		||||
        // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
 | 
			
		||||
        "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
 | 
			
		||||
 | 
			
		||||
        /* Type Checking */
 | 
			
		||||
        "strict": true /* Enable all strict type-checking options. */,
 | 
			
		||||
        "noImplicitAny": true /* Enable error reporting for expressions and declarations with an implied 'any' type. */,
 | 
			
		||||
        "strictNullChecks": true /* When type checking, take into account 'null' and 'undefined'. */,
 | 
			
		||||
        "strictFunctionTypes": true /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */,
 | 
			
		||||
        "strictBindCallApply": true /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */,
 | 
			
		||||
        "strictPropertyInitialization": true /* Check for class properties that are declared but not set in the constructor. */,
 | 
			
		||||
        "noImplicitThis": true /* Enable error reporting when 'this' is given the type 'any'. */,
 | 
			
		||||
        "useUnknownInCatchVariables": true /* Default catch clause variables as 'unknown' instead of 'any'. */,
 | 
			
		||||
        "alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
 | 
			
		||||
        "noUnusedLocals": true /* Enable error reporting when local variables aren't read. */,
 | 
			
		||||
        "noUnusedParameters": true /* Raise an error when a function parameter isn't read. */,
 | 
			
		||||
        "exactOptionalPropertyTypes": true /* Interpret optional property types as written, rather than adding 'undefined'. */,
 | 
			
		||||
        "noImplicitReturns": true /* Enable error reporting for codepaths that do not explicitly return in a function. */,
 | 
			
		||||
        "noFallthroughCasesInSwitch": true /* Enable error reporting for fallthrough cases in switch statements. */,
 | 
			
		||||
        "noUncheckedIndexedAccess": true /* Add 'undefined' to a type when accessed using an index. */,
 | 
			
		||||
        "noImplicitOverride": true /* Ensure overriding members in derived classes are marked with an override modifier. */,
 | 
			
		||||
        "noPropertyAccessFromIndexSignature": true /* Enforces using indexed accessors for keys declared using an indexed type. */,
 | 
			
		||||
        // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
 | 
			
		||||
        // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
 | 
			
		||||
 | 
			
		||||
        /* Completeness */
 | 
			
		||||
        // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
 | 
			
		||||
        "skipLibCheck": true /* Skip type checking all .d.ts files. */
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user