Skip to content

Commit 4562435

Browse files
NamcheeNamchee
committed
Initial commit
0 parents  commit 4562435

9 files changed

+4241
-0
lines changed

‎.editorconfig

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[*]
2+
end_of_line = lf
3+
indent_style = space
4+
indent_size = 2
5+
insert_final_newline = true

‎.eslintrc.js

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
module.exports = {
2+
'env': {
3+
'es2021': true,
4+
'node': true,
5+
},
6+
'extends': [
7+
'plugin:jsdoc/recommended',
8+
'google',
9+
],
10+
'parser': '@typescript-eslint/parser',
11+
'parserOptions': {
12+
'ecmaVersion': 12,
13+
'sourceType': 'module',
14+
},
15+
'plugins': [
16+
'@typescript-eslint',
17+
'jsdoc',
18+
],
19+
'rules': {
20+
'indent': [
21+
'error',
22+
2,
23+
{
24+
'SwitchCase': 1,
25+
},
26+
],
27+
'linebreak-style': [ // change this accordingly
28+
'warn',
29+
'unix',
30+
],
31+
'object-curly-spacing': [
32+
'error',
33+
'always',
34+
],
35+
'arrow-parens': [
36+
'error',
37+
'as-needed',
38+
{
39+
'requireForBlockBody': true,
40+
},
41+
],
42+
'require-jsdoc': 'off', // favor eslint-plugin-jsdoc
43+
'valid-jsdoc': 'off', // favor eslint-plugin-jsdoc
44+
'require-atomic-updates': 'off', // prevent async false alarm
45+
'@typescript-eslint/no-var-requires': 'off', // enforce ES6 import style
46+
'@typescript-eslint/no-explicit-any': 'off',
47+
'@typescript-eslint/camelcase': 'off', // prevent camelCase false alarm
48+
'no-unused-vars': 'off', // prevent enum export false alarm
49+
'@typescript-eslint/no-unused-vars': 'error',
50+
},
51+
};

‎.gitignore

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# TypeScript v1 declaration files
45+
typings/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Microbundle cache
57+
.rpt2_cache/
58+
.rts2_cache_cjs/
59+
.rts2_cache_es/
60+
.rts2_cache_umd/
61+
62+
# Optional REPL history
63+
.node_repl_history
64+
65+
# Output of 'npm pack'
66+
*.tgz
67+
68+
# Yarn Integrity file
69+
.yarn-integrity
70+
71+
# dotenv environment variables file
72+
.env
73+
.env.test
74+
75+
# parcel-bundler cache (https://parceljs.org/)
76+
.cache
77+
78+
# Next.js build output
79+
.next
80+
81+
# Nuxt.js build / generate output
82+
.nuxt
83+
dist
84+
85+
# Gatsby files
86+
.cache/
87+
# Comment in the public line in if your project uses Gatsby and not Next.js
88+
# https://nextjs.org/blog/next-9-1#public-directory-support
89+
# public
90+
91+
# vuepress build output
92+
.vuepress/dist
93+
94+
# Serverless directories
95+
.serverless/
96+
97+
# FuseBox cache
98+
.fusebox/
99+
100+
# DynamoDB Local files
101+
.dynamodb/
102+
103+
# TernJS port file
104+
.tern-port
105+
106+
# Stores VSCode versions used for testing VSCode extensions
107+
.vscode-test

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Cristopher
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Namchee's Boilerplate
2+
3+
[![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet.svg)](https://github.com/google/gts) [![devDependencies](https://img.shields.io/david/dev/namchee/namchee-boilerplate)](https://david-dm.org/namchee/namchee-boilerplate?type=dev)
4+
5+
Sebuah _boilerplate_ sederhana untuk project _backend_ NodeJS dengan menggunakan Typescript dan ESLint
6+
7+
## Fitur
8+
9+
1. Config Typescript _all-in-one_, tinggal pakai
10+
2. Config ESLint dengan [_preset_ Google](https://github.com/google/gts), namun tidak terlalu _strict_ dan di _fine-tune_ lebih lanjut
11+
3. Update _dependency_ berkala
12+
4. [TypeSync](https://github.com/jeffijoe/typesync) untuk mempermudah instalasi _types_ yang dibutuhkan TypeScript
13+
14+
## Instalasi
15+
16+
1. Clone repo ini atau eksekusi `git clone https://github.com/Namchee/namchee-boilerplate.git` di terminal. Untuk pengguna GitHub, dapat juga menggunakan repo ini sebagai _template_ repo untuk mempermudah _development_
17+
2. Ketik `npm install` atau `yarn` pada terminal anda
18+
3. Install _dependencies_ lain yang anda butuhkan dalam proses _development_
19+
4. Atur [tsconfig](tsconfig.json) sesuai kebutuhan, termasuk `include` dan `exclude` supaya tidak bermasalah pada proses _build_
20+
21+
## FAQ
22+
23+
### Mengapa tidak menggunakan `webpack`?
24+
25+
Karena _server-side_ JavaScript tidak membutuhkan _bundling_. `webpack` masuk akal pada _front-end_ karena browser tidak memiliki _module_, sedangkan NodeJS memiliki `require` sebagai _module system_ mereka.
26+
27+
### Mengapa tidak menggunakan `babel`?
28+
29+
Karena _server-side_ JavaScript tidak memerlukan _transpile_. Developerlah yang seharusnya mengontrol versi Node yang digunakan sesuai kebutuhan aplikasi.
30+
31+
### Seberapa sering _update_ dependency dilakukan?
32+
33+
Sesering yang saya bisa, setidaknya 2 minggu sekali.
34+
35+
## Lisensi
36+
37+
_Boilerplate_ ini menggunakan lisensi [MIT](LICENSE)

0 commit comments

Comments
 (0)