Node.js project environment bootstrap #env #config #eslint

.editorconfig

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

.eslintrc

{
  "extends": "standard",
  "env": {
    "node": true,
    "browser": true
  },
  "rules": {
    "valid-jsdoc": ["warn"],
    "max-len": ["error", 100],
    "arrow-parens": 0,
    "indent": ["error", 2, { "SwitchCase": 1 }],
    "no-shadow": ["error", {
      "builtinGlobals": true, "hoist": "all", "allow": [
        "cb", "done", "resolve", "reject", "name"
      ]
    }],
    "no-use-before-define": ["error", { "functions": true, "classes": true }],
    "no-inner-declarations": [2, "both"],
    "vars-on-top": 2
  }
}

.gitignore

# Loacal temp files
_temp*
_old

# IDE
.idea
.c9revisions
*.sublime*

# Env
.env

# Dependency directories
node_modules
typings

# Local dependency directory
!src/node_modules

# Optional npm cache directory
.npm

# Logs
logs
*.log
npm-debug.log*

# Test code coverage
coverage
lib-cov
.nyc_output

#Other
*.DS_Store

.travis.yml

language: node_js
node_js:
  - '6'
script:
  - npm run build

.vscode_settings.json

{
  "editor.rulers": [100],
  "editor.tabSize": 2,
  "editor.renderIndentGuides": true,
  "files.trimTrailingWhitespace": true,
  "files.insertFinalNewline": true
}

README.md

Title

This is an example file with maximal choices selected.

This is a long description.

Table of Contents

• Security
• Background
• Installation
• Usage
• API
• Contribute
• License

Security

Any optional sections

Background

Any optional sections

Install

This module depends upon a knowledge of Markdown.

Any optional sections

Usage

Any optional sections

API

Any optional sections

More optional sections

Contribute

See the contribute file!

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

Any optional sections

License

MIT © Richard McRichface.

eslint.config.js

// https://github.com/Yomguithereal/baobab/blob/master/eslint.config.js
module.exports = {
  extends: [
    '@yomguithereal/eslint-config/es6'
  ].map(require.resolve),
  rules: {
    'no-loop-func': 0
  }
};

eslint.sh

# npm
npm i eslint eslint-config-standard eslint-plugin-import eslint-plugin-node eslint-plugin-promiseeslint-plugin-standard -g

index.js

/*
 * Name
 * wmakeev/name
 *
 * Copyright (c) 2016, Vitaliy V. Makeev
 * Licensed under MIT.
 */
 
 module.exports = {}
 

init.sh

# npm
npm i --save-dev blue-tape coveralls eslint eslint-config-standard eslint-plugin-promise eslint-plugin-standard nyc tap-spec