fr/nork
1
0
Fork 0
mirror of https://github.com/filiprojek/nork.git synced 2024-11-02 10:02:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

code formatted

Browse Source
This commit is contained in:
Filip Rojek 2022-07-30 22:44:24 +02:00
parent 564cd09d8b
commit 03fbb74171
23 changed files with 266 additions and 261 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
.eslintrc.json
View File

@ -1,39 +1,25 @@
{
"env": {
"es2021": true,
"node": true
},
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 6,
"sourceType": "module"
},
"plugins": [
"@typescript-eslint"
],
"rules": {
"indent": [
"error",
"tab"
],
"linebreak-style": [
"error",
"unix"
],
"quotes": [
"error",
"single",
{
"allowTemplateLiterals": true
}
],
"semi": [
"error",
"never"
]
}
"env": {
"es2021": true,
"node": true
},
"extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 6,
"sourceType": "module"
},
"plugins": ["@typescript-eslint"],
"rules": {
"indent": ["error", "tab"],
"linebreak-style": ["error", "unix"],
"quotes": [
"error",
"single",
{
"allowTemplateLiterals": true
}
],
"semi": ["error", "never"]
}
}

4
.mocharc.json
View File

@ -1,4 +1,4 @@
{
"require": ["ts-node/register"],
"watch-files": ["./src/**/*.ts"]
"require": ["ts-node/register"],
"watch-files": ["./src/**/*.ts"]
}

15
.prettierrc Normal file
View File

@ -0,0 +1,15 @@
{
"tabWidth": 4,
"useTabs": true,
"singleQuote": true,
"semi": false,
"trailingComma": "none",
"jsxSingleQuote": true,
"jsxBracketSameLine": true,
"printWidth": 200,
"bracketSpacing": true,
"vueIndentScriptAndStyle": true,
"arrowParens": "always",
"bracketSameLine": false,
"endOfLine": "lf"
}

17
README.md
View File

@ -1,22 +1,29 @@
# Nork
Simple node.js tool that extends express projects.
- [About](#about)
- [Installation](#installation)
- [How to use](#how-to-use)
- [About](#about)
- [Installation](#installation)
- [How to use](#how-to-use)
## About
The point of this tool is to add to express some feeling of php framework Laravel. Primarily get simply express app into MVC architecture.
## Installation
```
npm install -g nork
```
This will install nork globally. If you would like to install nork for only one project, you can also install it locally. For local installation:
```
npm install nork
```
npm install nork
```
## How to use
```
Usage: nork <command> [options]

2
norkconfig.json
View File

@ -1 +1 @@
{"lang":"ts"}
{ "lang": "ts" }

114
package.json
View File

@ -1,58 +1,60 @@
{
"name": "nork",
"version": "3.0.5",
"description": "The best node.js 'framework' :)",
"main": "dist/app.js",
"bin": "dist/app.js",
"types": "dist/app.d.ts",
"scripts": {
"start": "npm run start:prod",
"start:dev": "ts-node src/app.ts",
"start:prod": "node dist/app.js",
"tsc": "tsc -p .",
"clean": "rimraf dist",
"copy-assets": "ts-node src/utils/copyAssets",
"build": "npm-run-all clean tsc copy-assets",
"test": "mocha --config .mocharc.json --watch src/**/*.test.ts",
"prepublish": "npm-run-all build"
},
"keywords": [
"node",
"framework",
"express",
"mvc"
],
"author": "Filip Rojek",
"license": "MIT",
"dependencies": {
"colors":"1.4.0",
"fs-extra": "^10.0.0",
"inquirer": "^8.1.2",
"pad": "^3.2.0"
},
"devDependencies": {
"@types/chai": "^4.2.22",
"@types/fs-extra": "^9.0.13",
"@types/inquirer": "^8.1.3",
"@types/mocha": "^9.0.0",
"@types/shelljs": "^0.8.11",
"@typescript-eslint/eslint-plugin": "^5.5.0",
"@typescript-eslint/parser": "^5.5.0",
"chai": "^4.3.4",
"eslint": "^8.3.0",
"mocha": "^9.1.3",
"npm-run-all": "^4.1.5",
"rimraf": "^3.0.2",
"shelljs": "^0.8.5",
"ts-node": "^10.4.0",
"typescript": "^4.5.2"
},
"repository": {
"type": "git",
"url": "git+https://github.com/filiprojek/nork.git"
},
"bugs": {
"url": "https://github.com/filiprojek/nork/issues"
},
"homepage": "https://github.com/filiprojek/nork/blob/master/README.md"
"name": "nork",
"version": "3.0.5",
"description": "The best node.js 'framework' :)",
"main": "dist/app.js",
"bin": "dist/app.js",
"types": "dist/app.d.ts",
"scripts": {
"start": "npm run start:prod",
"start:dev": "ts-node src/app.ts",
"start:prod": "node dist/app.js",
"tsc": "tsc -p .",
"clean": "rimraf dist",
"copy-assets": "ts-node src/utils/copyAssets",
"build": "npm-run-all clean tsc copy-assets",
"test": "mocha --config .mocharc.json --watch src/**/*.test.ts",
"prepublish": "npm-run-all build",
"format": "npx prettier --write ."
},
"keywords": [
"node",
"framework",
"express",
"mvc"
],
"author": "Filip Rojek",
"license": "MIT",
"dependencies": {
"colors": "1.4.0",
"fs-extra": "^10.0.0",
"inquirer": "^8.1.2",
"pad": "^3.2.0"
},
"devDependencies": {
"@types/chai": "^4.2.22",
"@types/fs-extra": "^9.0.13",
"@types/inquirer": "^8.1.3",
"@types/mocha": "^9.0.0",
"@types/shelljs": "^0.8.11",
"@typescript-eslint/eslint-plugin": "^5.5.0",
"@typescript-eslint/parser": "^5.5.0",
"chai": "^4.3.4",
"eslint": "^8.3.0",
"mocha": "^9.1.3",
"npm-run-all": "^4.1.5",
"prettier": "^2.7.1",
"rimraf": "^3.0.2",
"shelljs": "^0.8.5",
"ts-node": "^10.4.0",
"typescript": "^4.5.2"
},
"repository": {
"type": "git",
"url": "git+https://github.com/filiprojek/nork.git"
},
"bugs": {
"url": "https://github.com/filiprojek/nork/issues"
},
"homepage": "https://github.com/filiprojek/nork/blob/master/README.md"
}

55
progress-blog.md
View File

@ -1,36 +1,39 @@
/* spell-checker: disable */
/_ spell-checker: disable _/
# Todo:
- [ ] auth jwt refresh token based system
- https://auth0.com/blog/refresh-tokens-what-are-they-and-when-to-use-them/
- [ ] version of nork control
- [ ] upgrade to newer version system
- [ ] updatnout make files (obzvlast modely a rozlisovat modely podle norkconfigu)
- [ ] vyzadovat aktualni verzi 3.#.# pro make commandy (pouzivaly se jiny predtim soubory)
- [ ] moznost vytvorit projekt bez db
- [ ] auth jwt refresh token based system
- https://auth0.com/blog/refresh-tokens-what-are-they-and-when-to-use-them/
- [ ] version of nork control
- [ ] upgrade to newer version system
- [ ] updatnout make files (obzvlast modely a rozlisovat modely podle norkconfigu)
- [ ] vyzadovat aktualni verzi 3.#.# pro make commandy (pouzivaly se jiny predtim soubory)
- [ ] moznost vytvorit projekt bez db
### 11-24-2021
- zacal jsem predelavat nork do OOP
- co jsem udelal:
- [x] --help
- [x] --version
- [x] setup
- [x] make
- [x] create
- delam na tom
- je treba dopsat par types a fixnout zbytek erroru
- zatim netestovana funkcnost
- zacal jsem predelavat nork do OOP
- co jsem udelal:
- [x] --help
- [x] --version
- [x] setup
- [x] make
- [x] create
- delam na tom
- je treba dopsat par types a fixnout zbytek erroru
- zatim netestovana funkcnost
### 1-10-2022
- dodelal jsem create a otestoval ho
- [x] create
- dodelal jsem create a otestoval ho
- [x] create
### 7-30-2022
- norkconfig se generuje lepe a actually ho pouzivam
- pri vytvareni projektu je mozne vybrat si orm (mongoose & sequlize)
- default modely pro db se kopiruji na zaklade parametru db z norkconfigu
- updatnutej ts skeleton
- dropnul jsem support pro js
- version update: 3.0.5
- norkconfig se generuje lepe a actually ho pouzivam
- pri vytvareni projektu je mozne vybrat si orm (mongoose & sequlize)
- default modely pro db se kopiruji na zaklade parametru db z norkconfigu
- updatnutej ts skeleton
- dropnul jsem support pro js
- version update: 3.0.5

22
src/create.ts
View File

@ -14,7 +14,7 @@ export default class Create {
{
type: 'input',
name: 'project_name',
message: 'Enter project name:',
message: 'Enter project name:'
},
{
type: 'list',
@ -22,8 +22,8 @@ export default class Create {
name: 'lang',
choices: [
{ name: 'Typescript', value: 'ts' },
{ name: 'Javascript - DEPRECATED', value: 'js' },
],
{ name: 'Javascript - DEPRECATED', value: 'js' }
]
},
{
type: 'list',
@ -32,24 +32,24 @@ export default class Create {
choices: [
{ name: 'MongoDB - Mongoose', value: { db: 'mongodb', orm: 'mongoose' } },
{ name: 'MySQL - Sequelize', value: { db: 'mysql', orm: 'sequelize' } },
{ name: 'PostgreSQL - Sequelize', value: { db: 'postgresql', orm: 'sequelize' } },
],
{ name: 'PostgreSQL - Sequelize', value: { db: 'postgresql', orm: 'sequelize' } }
]
},
{
type: 'input',
name: 'author',
message: 'Enter your name:',
message: 'Enter your name:'
},
{
type: 'input',
name: 'email',
message: 'Enter your email:',
message: 'Enter your email:'
},
{
type: 'input',
name: 'website',
message: 'Enter your website:',
},
message: 'Enter your website:'
}
]
// remove first question if project name is already known
if (projectName) questions.shift()
@ -61,7 +61,7 @@ export default class Create {
author: answers.author,
database: answers.db,
website: answers.website,
email: answers.email,
email: answers.email
}
// copy skeleton to new project
@ -76,7 +76,7 @@ export default class Create {
const pkgJson = fs.readJsonSync(path.join(projectPath, 'package.json'))
pkgJson.name = data.project_name
pkgJson.author = `${data.author} <${data.email}> (${data.website})`
fs.writeFile(path.join(projectPath, 'package.json'), JSON.stringify(pkgJson, null, 2), err => {
fs.writeFile(path.join(projectPath, 'package.json'), JSON.stringify(pkgJson, null, 2), (err) => {
if (err) return global.logError(err.message)
})

2
src/interfaces/SetupInterface.ts
View File

@ -10,6 +10,6 @@ export interface Questions {
{
name: string
value: string
},
}
]
}

2
src/make-files/express-js/controller.js
View File

@ -4,5 +4,5 @@ const root_get = (req, res) => {
}
module.exports = {
root_get,
root_get
}

8
src/make-files/express-js/model.js
View File

@ -5,12 +5,12 @@ const modelSchema = new Schema(
{
title: {
type: String,
required: true,
},
required: true
}
},
{
timestamps: true,
},
timestamps: true
}
)
const ModelName = mongoose.model('ModelName', modelSchema)

8
src/make-files/express-ts/model.ts
View File

@ -4,12 +4,12 @@ const modelSchema = new Schema<any>(
{
title: {
type: String,
required: true,
},
required: true
}
},
{
timestamps: true,
},
timestamps: true
}
)
export default model('ModelName', modelSchema)

4
src/setup.ts
View File

@ -13,8 +13,8 @@ export default class Setup {
name: 'lang',
choices: [
{ name: 'Typescript', value: 'ts' },
{ name: 'Javascript', value: 'js' },
],
{ name: 'Javascript', value: 'js' }
]
}
const answers = await inquirer.prompt(Object(questions))
fs.writeJsonSync(path.join(process.cwd(), './norkconfig.json'), answers)

2
src/skeletons/express-js/norkconfig.json
View File

@ -1,3 +1,3 @@
{
"lang": "js"
"lang": "js"
}

4
src/skeletons/express-js/src/app.js
View File

@ -15,13 +15,13 @@ const app = express()
const dbURI = process.env.DB_URI
mongoose
.connect(dbURI, { useNewUrlParser: true, useUnifiedTopology: true, useCreateIndex: true })
.then(result => {
.then((result) => {
console.log('connected to db')
app.listen(port, () => {
console.log(`server is running on http://localhost:${port}`)
})
})
.catch(err => {
.catch((err) => {
console.log(err)
})

2
src/skeletons/express-js/src/controllers/rootController.js
View File

@ -4,5 +4,5 @@ const root_get = (req, res) => {
}
module.exports = {
root_get,
root_get
}

2
src/skeletons/express-ts/.prettierrc
View File

@ -11,5 +11,5 @@
"vueIndentScriptAndStyle": true,
"arrowParens": "always",
"bracketSameLine": false,
"endOfLine": "lf"
"endOfLine": "lf"
}

6
src/skeletons/express-ts/norkconfig.json
View File

@ -1,5 +1,5 @@
{
"lang": "ts",
"db": "",
"orm": ""
"lang": "ts",
"db": "",
"orm": ""
}

140
src/skeletons/express-ts/package.json
View File

@ -1,73 +1,73 @@
{
"name": "project-name",
"version": "1.0.0",
"description": "",
"main": "dist/server.js",
"private": "true",
"keywords": [],
"author": "",
"repository": "github:username/repo",
"license": "ISC",
"scripts": {
"start": "node dist/server.js",
"start:dev": "nodemon src/server.ts",
"test": "jest",
"clean": "rimraf dist/*",
"copy-assets": "npx ts-node src/utils/copyAssets",
"tsc": "tsc -p .",
"build": "npm-run-all clean tsc copy-assets",
"name": "project-name",
"version": "1.0.0",
"description": "",
"main": "dist/server.js",
"private": "true",
"keywords": [],
"author": "",
"repository": "github:username/repo",
"license": "ISC",
"scripts": {
"start": "node dist/server.js",
"start:dev": "nodemon src/server.ts",
"test": "jest",
"clean": "rimraf dist/*",
"copy-assets": "npx ts-node src/utils/copyAssets",
"tsc": "tsc -p .",
"build": "npm-run-all clean tsc copy-assets",
"format": "npx prettier --write ."
},
"dependencies": {
"colors": "1.4.0",
"cookie-parser": "^1.4.5",
"cors": "^2.8.5",
"dotenv": "^8.2.0",
"ejs": "^3.1.6",
"express": "^4.17.1",
"express-validator": "^6.14.2",
"fs-extra": "^10.0.0",
"jsonwebtoken": "^8.5.1",
"mongoose": "^5.12.3",
"pg": "^8.7.1",
"pg-hstore": "^2.3.4",
"sequelize": "^6.15.0"
},
"devDependencies": {
"@types/cookie-parser": "^1.4.2",
"@types/cors": "^2.8.10",
"@types/ejs": "^3.0.6",
"@types/express": "^4.17.11",
"@types/fs-extra": "^9.0.12",
"@types/jest": "^27.5.2",
"@types/jsonwebtoken": "^8.5.8",
"@types/mongoose": "^5.10.5",
"@types/morgan": "^1.9.2",
"@types/node": "^14.14.41",
"@types/shelljs": "^0.8.9",
"jest": "^27.0.6",
"npm-run-all": "^4.1.5",
"rimraf": "^3.0.2",
"shelljs": "^0.8.4",
"ts-jest": "^27.1.5",
"ts-node": "^10.8.1",
"typescript": "^4.2.4",
"morgan": "^1.10.0"
},
"jest": {
"preset": "ts-jest",
"testEnvironment": "node"
},
"nodemonConfig": {
"ignore": [
"**/*.test.ts",
"**/*.spec.ts",
".git",
"node_modules"
],
"watch": [
"src"
],
"ext": "ts, js"
}
},
"dependencies": {
"colors": "1.4.0",
"cookie-parser": "^1.4.5",
"cors": "^2.8.5",
"dotenv": "^8.2.0",
"ejs": "^3.1.6",
"express": "^4.17.1",
"express-validator": "^6.14.2",
"fs-extra": "^10.0.0",
"jsonwebtoken": "^8.5.1",
"mongoose": "^5.12.3",
"pg": "^8.7.1",
"pg-hstore": "^2.3.4",
"sequelize": "^6.15.0"
},
"devDependencies": {
"@types/cookie-parser": "^1.4.2",
"@types/cors": "^2.8.10",
"@types/ejs": "^3.0.6",
"@types/express": "^4.17.11",
"@types/fs-extra": "^9.0.12",
"@types/jest": "^27.5.2",
"@types/jsonwebtoken": "^8.5.8",
"@types/mongoose": "^5.10.5",
"@types/morgan": "^1.9.2",
"@types/node": "^14.14.41",
"@types/shelljs": "^0.8.9",
"jest": "^27.0.6",
"npm-run-all": "^4.1.5",
"rimraf": "^3.0.2",
"shelljs": "^0.8.4",
"ts-jest": "^27.1.5",
"ts-node": "^10.8.1",
"typescript": "^4.2.4",
"morgan": "^1.10.0"
},
"jest": {
"preset": "ts-jest",
"testEnvironment": "node"
},
"nodemonConfig": {
"ignore": [
"**/*.test.ts",
"**/*.spec.ts",
".git",
"node_modules"
],
"watch": [
"src"
],
"ext": "ts, js"
}
}

14
src/skeletons/sequelize-models/User.ts
View File

@ -10,26 +10,26 @@ Instance.init(
type: DataTypes.UUID,
primaryKey: true,
allowNull: false,
unique: true,
unique: true
},
username: {
type: DataTypes.STRING,
allowNull: false,
allowNull: false
},
password: {
type: DataTypes.STRING,
allowNull: false,
allowNull: false
},
email: {
type: DataTypes.STRING,
allowNull: false,
unique: true,
},
unique: true
}
},
{
sequelize: db,
tableName: path.basename(__filename).split('.')[0].toLowerCase(),
},
tableName: path.basename(__filename).split('.')[0].toLowerCase()
}
)
export default Instance

34
tsconfig.json
View File

@ -1,23 +1,15 @@
{
"compilerOptions": {
"target": "es6", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
"module": "commonjs", /* Specify what module code is generated. */
"outDir": "./dist", /* Specify an output folder for all emitted files. */
"rootDir": "./src", /* Specify the root folder within your source files. */
"strict": true, /* Enable all strict type-checking options. */
"baseUrl": "./", /* Base directory to resolve non-absolute module names. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
"skipLibCheck": true, /* Skip type checking all .d.ts files. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
"declaration": true,
},
"exclude": [
"_old",
"node_modules",
"src/make-files",
"src/skeletons",
"src/tests",
"src/interfaces",
"src/utils"
]
"compilerOptions": {
"target": "es6" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
"module": "commonjs" /* Specify what module code is generated. */,
"outDir": "./dist" /* Specify an output folder for all emitted files. */,
"rootDir": "./src" /* Specify the root folder within your source files. */,
"strict": true /* Enable all strict type-checking options. */,
"baseUrl": "./" /* Base directory to resolve non-absolute module names. */,
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
"skipLibCheck": true /* Skip type checking all .d.ts files. */,
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
"declaration": true
},
"exclude": ["_old", "node_modules", "src/make-files", "src/skeletons", "src/tests", "src/interfaces", "src/utils"]
}