@elunic/ecs

@elunic/ecs

The elunic coding styles

Table of Contents

• @elunic/ecs
  • Table of Contents
  • Installation
  • Usage
    • Single packages vs. all-in-package
    • tsconfig
    • eslint
      • Default config (non-fix)
      • Fix config
    • tslint
      • tslint-react peerDependency for React
    • Prettier
    • EditorConfig
    • Commitlint
  • License

Installation

$ npm i -D @elunic/ecs

Usage

Single packages vs. all-in-package

This is really only a meta-package/abstraction package that includes the component packages:

• @elunic/ecs-prettier
• @elunic/ecs-tsconfig
• @elunic/ecs-tslint
• @elunic/ecs-commitlint
• @elunic/eslint-config-ecs

If you only require specific styles, including only those might be a good idea, for example to reduce dependency exposure (for npm audit) or to get less peerDependency messages.

tsconfig

• tsconfig/tsconfig.json
• tsconfig/tsconfig.prod.json

Example usage for your /tsconfig.json:

{
  "extends": "@elunic/ecs/tsconfig/tsconfig.json",
  "rules": {}
}

eslint

Note: The eslint config is located in a separate package, @elunic/eslint-config-ecs due to the namespacing requirements for sharing eslint configs. That package is a dependency of this package and so is automatically installed alongside this one.

Note for Angular projects: There is currently no eslint configuration for Angular, as Angular itself has not yet switched to using eslint. For Angular projects, tslint should still be used.

Default config (non-fix)

Example usage for your /.eslintrc.json:

{
  "extends": "@elunic/eslint-config-ecs",
  "rules": {}
}

Fix config

Example usage for your /.eslintrc.fix.json:

{
  "extends": "@elunic/eslint-config-ecs/fix",
  "rules": {}
}

tslint

Note that tslint is deprecated with an expected EOL at the end of 2020.

Currently, the tslint configurations for Angular are still in use because Angular has not yet switched to eslint.

• tslint/tslint.json
• tslint/tslint.fix.json
• tslint/tslint-angular7.json
• tslint/tslint-angular7.fix.json
• tslint/tslint-angular8.json
• tslint/tslint-angular8.fix.json
• tslint/tslint-react16.json
• tslint/tslint-react16.fix.json

Example usage for your /tslint.json:

{
  "extends": "@elunic/ecs/tslint/tslint.json",
  "rules": {}
}

tslint-react peerDependency for React

For React, the tslint-react peerDependency is required.

Prettier

• prettier/prettier.config.js

Example usage for your /.prettierrc.json:

"@elunic/ecs/prettier"

EditorConfig

• editorconfig/.editorconfig

Must currently be included by copying it to your project root.

Commitlint

• commitlint/index.js

Example usage for your /.commitlintrc.json:

{
  "extends": [
    "@elunic/ecs/commitlint"
  ]
}

License

MIT License

Copyright (c) 2019-2020 elunic AG/William Hefter [e-mail]

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.