Skip to content

eigen-space/codestyle

Repository files navigation

CodeStyle Build Status

Description of all dev. standards which this project exists for.

Main language: TypeScript

This project contains:

  1. Typescript configuration.
  2. README linter.
  3. Packages of eslint rules.

Project structure

/configs - Some configurations, eg ide
/src
    /configs - Packaged configurations
    /sandbox
    /scripts

How to start development with sandbox

  1. Build eslint-plugin-eigenspace-script project
        > cd src/packages/eslint-plugin-eigenspace-script
        > yarn build
    
  2. Run yarn from root project

How to run specs

To run specs for all subprojects, just call yarn test from the root project

Why do we have that dev dependencies?

  • @eigenspace/commit-linter - commit linter.
  • @eigenspace/helper-scripts - common scripts for dev. environment.
  • @types/* - contains type definitions for specific library.
  • eslint-plugin-eigenspace-script - eslint script rules package.
  • eslint-plugin-eigenspace-react - eslint react rules package.
  • eslint-plugin-eigenspace-redux - eslint redux rules package.
  • eslint-plugin-eigenspace-styles - eslint styles rules package.
  • eslint - it checks code for readability, maintainability, and functionality errors.
  • ts-jest - used for jest to work with typescript files.
  • typescript - is a superset of JavaScript that have static type-checking and ECMAScript features.
  • husky - used for configure git hooks.
  • jest - spec runner.
  • lint-staged - used for configure linters against staged git files.
  • react - used for sandbox and testing React rules.
  • react-redux - used for sandbox and testing React redux rules.

CI

Important!

Travis creates the .npmrc file during ci startup. This file contains the access token to the npm repository.

About

Typescript code style

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published