@anthonylzq/simba.js 1.4.0

package/.eslintrc

@@ -0,0 +1,64 @@
+{
+  "env": {
+    "node": true
+  },
+  "root": true,
+  "plugins": [
+    "import",
+    "prettier"
+  ],
+  "extends": [
+    "standard",
+    "eslint:recommended",
+    "prettier"
+  ],
+  "rules": {
+    "@typescript-eslint/no-var-requires": "off",
+    "arrow-parens": [
+      "error",
+      "as-needed"
+    ],
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        "devDependencies": true
+      }
+    ],
+    "max-len": [
+      "error",
+      {
+        "code": 80,
+        "ignoreComments": true,
+        "ignoreRegExpLiterals": true,
+        "ignoreTemplateLiterals": true,
+        "ignoreTrailingComments": true,
+        "ignoreStrings": true,
+        "ignoreUrls": true
+      }
+    ],
+    "newline-before-return": "error",
+    "object-curly-spacing": [
+      "error",
+      "always"
+    ],
+    "prefer-const": "error",
+    "prettier/prettier": [
+      "error",
+      {
+        "arrowParens": "avoid",
+        "bracketSpacing": true,
+        "printWidth": 80,
+        "quoteProps": "as-needed",
+        "semi": false,
+        "singleQuote": true,
+        "tabWidth": 2,
+        "trailingComma": "none"
+      }
+    ],
+    "radix": [
+      "error",
+      "as-needed"
+    ],
+    "spaced-comment": ["error", "always"]
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [1.4.0](https://github.com/AnthonyLzq/simba.js/compare/v1.3.1...v1.4.0) (2021-12-12)
+
+
+### Features
+
+* simplified the code ([dde8f2e](https://github.com/AnthonyLzq/simba.js/commit/dde8f2e27f86f60321af2f12b53546227d0ffe64))
+
+### [1.3.1](https://github.com/AnthonyLzq/simba.js/compare/v1.3.0...v1.3.1) (2021-12-12)
+
+
+### Features
+
+* updated docs ([809afaa](https://github.com/AnthonyLzq/simba.js/commit/809afaad2c1c3046fab509842118064ec6a61d5f))
+
+## [1.3.0](https://github.com/AnthonyLzq/simba.js/compare/v1.2.0...v1.3.0) (2021-12-12)
+
+
+### Features
+
+* implemented eslint rules ([748fb91](https://github.com/AnthonyLzq/simba.js/commit/748fb91a031102855dd7ba08344cc1ec3e181a4f))
+* implemented support for global variables (Node.js v16), linted all the code, fixed unlicensed project bug and simplified project structure ([ae4876f](https://github.com/AnthonyLzq/simba.js/commit/ae4876f249ff7dfd16fd4af7e41b3388c7de0f6a))
+
+## [1.2.0](https://github.com/AnthonyLzq/simba.js/compare/v1.1.3...v1.2.0) (2021-10-18)
+
+
+### Features
+
+* implemented support for project names with more than a word and updated dependencies ([2600413](https://github.com/AnthonyLzq/simba.js/commit/2600413bf7a5ef92e554738066e9bc4aea892f6f))
+
+### [1.1.3](https://github.com/AnthonyLzq/simba.js/compare/v1.1.2...v1.1.3) (2021-10-17)
+
+
+### Bug Fixes
+
+* fixed bin path ([bf194ff](https://github.com/AnthonyLzq/simba.js/commit/bf194ff21e6aaf63dd1a80c104b8a3567f0887b1))
+
+### [1.1.2](https://github.com/AnthonyLzq/simba.js/compare/v1.1.1...v1.1.2) (2021-10-17)
+
+
+### Bug Fixes
+
+* updated eslint package (eslint-config-airbnb -> eslint-config-airbnb-base) ([06547bc](https://github.com/AnthonyLzq/simba.js/commit/06547bc618e79f9f6e47e3b0fbd188358befe408))
+
+### [1.1.1](https://github.com/AnthonyLzq/simba.js/compare/v1.0.1...v1.1.1) (2021-10-17)
+
+
+### Features
+
+* added new eslint package and some new rules ([d79426c](https://github.com/AnthonyLzq/simba.js/commit/d79426c23fc899128d68c8b2e79ed7c5c0e4b18b))
+
+### [1.0.1](https://github.com/AnthonyLzq/simba.js/compare/v1.0.0...v1.0.1) (2021-10-01)
+
+
+### Bug Fixes
+
+* flag for unlicensed ([6b20a5b](https://github.com/AnthonyLzq/simba.js/commit/6b20a5b8a9ad60e5278b38252849fe5c3b2d54a4))
+
+## 1.0.0 (2021-09-28)
+
+
+### Features
+
+* first simba.js release ([d10fa01](https://github.com/AnthonyLzq/simba.js/commit/d10fa0199a8bff941da186c33fc16b512295a037))
+* updated package name and added standard-version command ([d0d0906](https://github.com/AnthonyLzq/simba.js/commit/d0d09064587a814f97d7a63b865b28a6f05030ad))

package/LICENSE

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

package/README.md

@@ -0,0 +1,234 @@
+# Simba.js
+
+Set up a modern backend app by running one command. This project has the goal to create a complete setup for a backend application using `TypeScript` and `Express`. It will create many files that are usually created manually. Currently the following files are being created:
+
+- `.env`
+- `.eslintignore`
+- `.eslintrc.js`
+- `.gitignore`
+- `CHANGELOG.md`
+- `Dockerfile`
+- `heroku.yml` (optional)
+- `LICENSE` (optional, `MIT` as example)
+- `nodemon.json`
+- `package.json`
+- `README.md`
+- `tsconfig.json`
+- `webpack.config.js`
+
+## Installation
+
+This package is meant to be installed globally in your computer by using:
+
+```bash
+npm i -g simba.js
+```
+
+## Usage
+
+<!-- Also, if you don't want to install it globally, you can use npx as follows:
+
+```bash
+npx simba.js
+``` -->
+
+As developer you have two main options to create your new project, one is by running:
+
+```bash
+simba -q
+```
+
+By doing this your prompt will ask you the following questions:
+
+- `Yarn or npm?`, only one of them is valid.
+- `Project name:`, at least one character must be provided.
+- `Project description:`, at least one character must be provided.
+- `Author:`, at least one character must be provided.
+- `Email:`, a correct email address must be provided.
+- `Project version (0.1.0):` the initial version of the project, `0.1.0` as default.
+- `Select your license [1...7]:`, the license you have chosen for the project.
+- `License year (current year):`, the year where your license starts, current year as default.
+- `Will this project be deployed with Heroku? [y/n]:`, yes or no question, only **y** or **n** is accepted. This is not case sensitive.
+
+The second option you have is by passing flags in one single command. If you need help, please run:
+
+```bash
+simba -h
+```
+
+This will generate the following output:
+
+```bash
+Usage: npx simba [options] or simba [options] (if you it installed globally) or
+only simba if you want to be asked for the options one by one
+
+Options:
+  -a, --author              Author of the project
+  -e, --email               Email of the author
+  -N, --projectName         Project name
+  -D, --projectDescription  Project description
+  -H, --heroku              Whether or not the project will be deployed using
+                            Heroku                    [boolean] [default: false]
+  -l, --license             Type of license for the project, it can be one of:
+                            MIT, Apache 2.0, MPL 2.0, LGPL 3.0, GPL 3.0 and AGPL
+                            3.0, in lowercase without its version
+                                                         [default: "unlicensed"]
+  -v, --version             Project initial version           [default: "0.1.0"]
+  -y, --licenseYear         Year when the license starts       [default: "2021"]
+  -n, --npm                 Whether or not the project should use npm as package
+                            manager                   [boolean] [default: false]
+  -f, --mainFile            Main file of the project   [default: "src/index.ts"]
+  -q, --questions           Whether or not you want to be asked to answer the
+                            questions related to the project one by one
+                                                      [boolean] [default: false]
+  -h, --help                Show help                                  [boolean]
+
+Examples:
+  simba -a Anthony -e sluzquinosa@uni.pe -N "Project Name" -D "Project
+  description"
+
+Developed by AnthonyLzq
+```
+
+Regardless of the option chosen, a new folder will be generated with the name of the project, it will contain the following structure:
+
+```
+📦node_modules
+📦src
+ ┣ 📂@types
+ ┃ ┣ 📜index.d.ts
+ ┣ 📂controllers
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
+ ┣ 📂dto-interfaces
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.dto.ts
+ ┣ 📂models
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
+ ┣ 📂network
+ ┃ ┣ 📜index.ts
+ ┃ ┣ 📜routes.ts
+ ┃ ┗ 📜server.ts
+ ┣ 📂routes
+ ┃ ┣ 📜home.ts
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜user.ts
+ ┣ 📂utils
+ ┃ ┣ 📜index.ts
+ ┃ ┗ 📜response.ts
+ ┗ 📜index.ts
+📜.env
+📜.eslintignore
+📜.eslintrc.js
+📜.gitignore
+📜CHANGELOG.md
+📜Dockerfile
+📜heroku.yml
+📜LICENSE
+📜nodemon.json
+📜package.json
+📜README.md
+📜tsconfig.json
+📜webpack.config.js
+📜yarn.lock (or package-lock.json)
+```
+
+### Examples
+
+Let's suppose you want to build a project that will be deployed to Heroku, so should run:
+
+```bash
+simba -a myName -e myEmail@email.com -N myProject -D 'This is a test' -H -l mit
+```
+
+Here we are specifying that we want to create a new project called `myProject` using the `MIT` license, and my name and my email are respectively: `myName` and `myEmail@email.com`.
+
+As default, `yarn` is selected as package manager, but you don't want to use it, so you can pass the flag `-n` or `--npm` as follows:
+
+```bash
+simba -a myName -e myEmail@email.com -N myProject -D 'This is a test' -H -l mit -n
+```
+
+Finally, you may not want to use a license or one of the available licenses, don't worry, just don't pass the flag `-l` neither `--license` as follows:
+
+```bash
+simba -a myName -e myEmail@email.com -N myProject -D 'This is a test' -H
+```
+
+### Some considerations
+
+- This project is based in other project from my own, [`typescript-project-generator`](https://www.npmjs.com/package/typescript-project-generator), but only considering the `express-mongoose-node` part.
+- You are able to run a server that has one main route, `home` (`/`), and another one, `user` (`/user` or `/user/:userId`).
+- To connect your server with your `MongoDB` database, you need to provide your `uri` in the `.env`.
+- Once you have done that, now you can perform the following `HTTP REQUEST`: `GET`, `POST`, `PATCH` and `DELETE`.
+- In order to use global variables, just add the one you need in the `src/@types/index.d.ts` file, and add a new `var` with its type to the `global` interface, as follows:
+    ```ts
+    // src/@types/index.d.ts
+
+    // Some code...
+    declare global {
+      var globalStringVariable: string
+      // Some more code...
+    }
+    // Some more code...
+
+    // another file
+    globalStringVariable = 'Hi mom, I am global'
+    console.log({ globalStringVariable })
+    ```
+
+- The provided project structure is inspired in my personal experience as [`Node.js`](https://nodejs.org/en/) developer and the [`Nest`](https://nestjs.com/) framework.
+- The server is fully tested and has no errors (at least for now), feel free to report one [here](https://github.com/AnthonyLzq/simba.js/issues).
+- Support for windows and linux platforms is available.
+- To check the content of the files generated, please check the `example` folder.
+- If you provide a project name that contains spaces, something like 'My awesome Project',  every space will be replaced with a hyphen. So at the end your project name will be 'My-awesome-project', but in its README.md file, the hyphens will be removed and the project name will be parsed to title case (My Awesome Project).
+- Finally, `git` will be initialized and a list of libraries will be installed. Check the [**notes**](#notes).
+
+## What is new?
+
+Please check the `changelog.md` file.
+
+## <a name="notes"></a>Notes
+
+Here is the list of the packages that are being installed, as `devDependencies`:
+
+- [`@types/express`](https://www.npmjs.com/package/@types/express)
+- [`@types/http-errors`](https://www.npmjs.com/package/@types/http-errors)
+- [`@types/morgan`](https://www.npmjs.com/package/@types/morgan)
+- [`@types/node`](https://www.npmjs.com/package/@types/node/v/14.17.5)
+- [`@types/swagger-ui-express`](https://www.npmjs.com/package/@types/swagger-ui-express)
+- [`@typescript-eslint/eslint-plugin`](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
+- [`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser)
+- [`dotenv`](https://www.npmjs.com/package/dotenv)
+- [`eslint`](https://www.npmjs.com/package/eslint)
+- [`eslint-config-airbnb-typescript`](https://www.npmjs.com/package/eslint-config-airbnb-typescript)
+- [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier)
+- [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import)
+- [`eslint-plugin-prettier`](https://www.npmjs.com/package/eslint-plugin-prettier)
+- [`eslint-plugin-sort-keys-fix`](https://www.npmjs.com/package/eslint-plugin-sort-keys-fix)
+- [`eslint-plugin-typescript-sort-keys`](https://www.npmjs.com/package/eslint-plugin-typescript-sort-keys)
+- [`nodemon`](https://www.npmjs.com/package/nodemon)
+- [`prettier`](https://www.npmjs.com/package/prettier)
+- [`standard-version`](https://www.npmjs.com/package/standard-version)
+- [`ts-loader`](https://www.npmjs.com/package/ts-loader)
+- [`ts-node`](https://www.npmjs.com/package/ts-node)
+- [`typescript`](https://www.npmjs.com/package/typescript)
+- [`webpack`](https://www.npmjs.com/package/webpack)
+- [`webpack-cli`](https://www.npmjs.com/package/webpack-cli)
+- [`webpack-node-externals`](https://www.npmjs.com/package/webpack-node-externals)
+
+As `dependencies`:
+
+- [`express`](https://expressjs.com/)
+- [`http-errors`](https://www.npmjs.com/package/http-errors)
+- [`joi`](https://joi.dev/api/?v=17.4.2)
+- [`mongoose`](https://mongoosejs.com/)
+- [`morgan`](https://www.npmjs.com/package/morgan)
+- [`swagger-ui-express`](https://www.npmjs.com/package/swagger-ui-express)
+
+Feel free to contribute to this project. Every contribution will be appreciated.
+
+## Author
+
+- **Anthony Luzquiños** - _Initial Work_ - _Documentation_ - [AnthonyLzq](https://github.com/AnthonyLzq).

package/bin/index.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const main = require('../lib')
+
+main()

package/lib/index.js

@@ -0,0 +1,285 @@
+const readLineSync = require('readline-sync')
+const yargs = require('yargs/yargs')
+const { hideBin } = require('yargs/helpers')
+
+const installation = require('./src/installation')
+
+const CURRENT_YEAR = `${new Date().getFullYear()}`
+const argv = yargs(hideBin(process.argv))
+  .version(false)
+  .usage(
+    'Usage: npx simba [options] or simba [options] (if you it installed globally) or only simba if you want to be asked for the options one by one'
+  )
+  .example(
+    'simba -a Anthony -e sluzquinosa@uni.pe -N "Project Name" -D "Project description"'
+  )
+  .alias('a', 'author')
+  .nargs('a', 1)
+  .describe('a', 'Author of the project')
+  .alias('e', 'email')
+  .nargs('e', 1)
+  .describe('e', 'Email of the author')
+  .alias('N', 'projectName')
+  .nargs('N', 1)
+  .describe('N', 'Project name')
+  .alias('D', 'projectDescription')
+  .nargs('D', 1)
+  .describe('D', 'Project description')
+  .alias('H', 'heroku')
+  .describe('H', 'Whether or not the project will be deployed using Heroku')
+  .alias('l', 'license')
+  .nargs('l', 1)
+  .describe(
+    'l',
+    'Type of license for the project, it can be one of: MIT, Apache 2.0, MPL 2.0, LGPL 3.0, GPL 3.0 and AGPL 3.0, in lowercase without its version'
+  )
+  .alias('v', 'version')
+  .nargs('v', 1)
+  .describe('v', 'Project initial version')
+  .alias('y', 'licenseYear')
+  .nargs('y', 1)
+  .describe('y', 'Year when the license starts')
+  .alias('n', 'npm')
+  .describe('n', 'Whether or not the project should use npm as package manager')
+  .alias('f', 'mainFile')
+  .nargs('f', 1)
+  .describe('f', 'Main file of the project')
+  .alias('q', 'questions')
+  .describe(
+    'q',
+    'Whether or not you want to be asked to answer the questions related to the project one by one'
+  )
+  .default({
+    H: false,
+    n: false,
+    y: CURRENT_YEAR,
+    l: 'unlicensed',
+    v: '0.1.0',
+    f: 'src/index.ts',
+    q: false
+  })
+  .boolean(['H', 'n', 'q'])
+  .help('h')
+  .alias('h', 'help')
+  .epilog('Developed by AnthonyLzq').argv
+
+/** @type {Config} */
+const config = {
+  author: '',
+  email: '',
+  projectName: '',
+  projectDescription: '',
+  heroku: false,
+  license: 'unlicensed',
+  version: '0.1.0',
+  licenseYear: CURRENT_YEAR,
+  npm: false,
+  manager: 'yarn add',
+  mainFile: 'src/index.ts'
+}
+const UNLICENSED = 'unlicensed'
+const LICENSES = [
+  'MIT',
+  'Apache 2.0',
+  'MPL 2.0',
+  'LGPL 3.0',
+  'GPL 3.0',
+  'AGPL 3.0'
+]
+const POSSIBLE_LICENSES = ['mit', 'apache', 'mpl', 'lgpl', 'gpl', 'agpl']
+const ONE_CHARACTER_REGEXP = /^\w/
+const YEAR_REGEXP = /^\d{4}$/
+const EMAIL_REGEXP =
+  /^(([^<>()[\].,;:\s@"]+(\.[^<>()[\].,;:\s@"]+)*)|(".+"))@(([^<>()[\].,;:\s@"]+\.)+[^<>()[\].,;:\s@"]{2,})$/i
+
+const main = async () => {
+  if (argv.q) {
+    readLineSync.promptCLLoop(
+      {
+        npm: () => {
+          config.npm = true
+
+          return true
+        },
+        yarn: () => true
+      },
+      {
+        caseSensitive: false,
+        limitMessage: 'That is not a valid option',
+        prompt: '> Yarn or npm? '
+      }
+    )
+
+    if (config.npm) config.manager = 'npm i'
+
+    readLineSync.promptLoop(
+      input => {
+        config.projectName = input.toLowerCase()
+
+        return config.projectName !== ''
+      },
+      {
+        limit: ONE_CHARACTER_REGEXP,
+        limitMessage: 'The project must have a name!',
+        prompt: '> Project name: '
+      }
+    )
+
+    readLineSync.promptLoop(
+      input => {
+        config.projectDescription = input
+
+        return config.projectDescription !== ''
+      },
+      {
+        limit: ONE_CHARACTER_REGEXP,
+        limitMessage: 'The project must have a description!',
+        prompt: '> Project description: '
+      }
+    )
+
+    readLineSync.promptLoop(
+      input => {
+        config.author = input
+
+        return config.author !== ''
+      },
+      {
+        limit: ONE_CHARACTER_REGEXP,
+        limitMessage: 'The project must have an author!',
+        prompt: '> Author: '
+      }
+    )
+
+    config.email = readLineSync.questionEMail('> Email: ', {
+      limit: EMAIL_REGEXP,
+      limitMessage: 'That is not a valid email!'
+    })
+
+    config.version = readLineSync.question('> Project version (0.1.0): ')
+    config.version = config.version === '' ? '0.1.0' : config.version
+
+    const licensePos = readLineSync.keyInSelect(
+      LICENSES,
+      '> Select your license: ',
+      {
+        cancel: false
+      }
+    )
+
+    config.license = LICENSES[licensePos]
+      .toLowerCase()
+      .replace(/ /g, '-')
+      .replace('d', '')
+
+    readLineSync.promptLoop(
+      input => {
+        if (input !== '') config.licenseYear = input
+
+        return YEAR_REGEXP.test(config.licenseYear)
+      },
+      {
+        limit: [YEAR_REGEXP, ''],
+        limitMessage: 'That is not a valid license year!',
+        prompt: `> License year (${config.licenseYear}): `
+      }
+    )
+
+    config.heroku = readLineSync.keyInYNStrict(
+      '> Will this project be deployed with Heroku? ',
+      {
+        caseSensitive: false
+      }
+    )
+
+    config.mainFile = readLineSync.question('> Main file (src/index.ts): ')
+  } else {
+    if (!argv.author) return console.log('Error! An author is required!')
+    else config.author = argv.author
+
+    if (!argv.email) return console.log('Error! An email is required!')
+    else {
+      if (!EMAIL_REGEXP.test(argv.email))
+        return console.log('That is not a valid email!')
+
+      config.email = argv.email
+    }
+
+    if (!argv.projectName)
+      return console.log('Error! A project name is required!')
+    else if (argv.projectName.includes(' '))
+      config.projectName = argv.projectName.replace(/ /g, '-')
+    else config.projectName = argv.projectName
+
+    if (!argv.projectDescription)
+      return console.log('Error! A project description is required')
+    else config.projectDescription = argv.projectDescription
+
+    if (argv.heroku) config.heroku = true
+
+    if (!argv.license || argv.license === UNLICENSED)
+      console.log('License was not provided')
+    else {
+      if (!POSSIBLE_LICENSES.includes(argv.license.toLowerCase()))
+        return console.log(
+          'Wrong license, licenses available are: MIT, Apache 2.0, MPL 2.0, LGPL 3.0, GPL 3.0 and AGPL 3.0. Please, provide one of then in lowercase without its version in case you want to have a license, otherwise skip license argument'
+        )
+
+      switch (argv.license) {
+        case POSSIBLE_LICENSES[0]:
+          config.license = argv.license
+          break
+        case POSSIBLE_LICENSES[1]:
+        case POSSIBLE_LICENSES[2]:
+          config.license = `${argv.license}-2.0`
+          break
+        case POSSIBLE_LICENSES[3]:
+        case POSSIBLE_LICENSES[4]:
+        case POSSIBLE_LICENSES[5]:
+          config.license = `${argv.license}-3.0`
+          break
+      }
+    }
+
+    if (!argv.licenseYear)
+      console.log(
+        `Year license was not provided, using ${config.licenseYear} as default`
+      )
+    else if (!YEAR_REGEXP.test(config.licenseYear))
+      return console.log(
+        'Year license format was wrong, please provide a YYYY format'
+      )
+
+    if (!argv.version)
+      console.log('Initial version wa not provided, using 0.1.0 as default')
+    else config.version = argv.version
+
+    if (!argv.npm) console.log('Using yarn as default package manager')
+    else {
+      config.npm = true
+      config.manager = 'npm i'
+    }
+
+    if (!argv.mainFile) console.log('Using src/index.ts as default main file')
+    else config.mainFile = argv.mainFile
+  }
+
+  await installation(config)
+}
+
+module.exports = main
+
+/**
+ * @typedef {Object} Config configuration to initialize a project
+ * @property {String} author author of the project
+ * @property {String} email email of the project author
+ * @property {String} projectName project name
+ * @property {String} projectDescription project description
+ * @property {Boolean} heroku true if the project will be deployed in heroku
+ * @property {'unlicensed'|'mit'|'apache-2.0'|'mpl-2.0'|'lgpl-3.0'|'gpl-3.0'|'agpl-3.0'} license project license
+ * @property {String} version project initial version
+ * @property {String} licenseYear year when the license starts in format YYYY
+ * @property {Boolean} npm true means that the package manager will be npm, otherwise yarn
+ * @property {'yarn add'|'npm i'} manager command that will be used to install packages
+ * @property {String} mainFile main file of the project
+ */

package/lib/src/functions/changelog.js

@@ -0,0 +1,15 @@
+const writeFile = require('../utils/writeFile')
+const titleCase = require('../utils/titleCase')
+
+/**
+ * @param {String} projectName
+ * @returns {Promise<void>}
+ */
+module.exports = async projectName => {
+  const data = {
+    changelogContent: `# ${titleCase(projectName)}`,
+    changelogFile: 'CHANGELOG.md'
+  }
+
+  await writeFile(`${projectName}/${data.changelogFile}`, data.changelogContent)
+}