Skip to content
This repository has been archived by the owner on Nov 29, 2024. It is now read-only.

Common dev stack config files for all of the OAK'S LAB projects

Notifications You must be signed in to change notification settings

oakslab/ooo-config-examples

Repository files navigation

Classification

We're OAK'S LAB

The creative ecosystem specializing in building businesses, architecting software and educating the future leaders in tech.

What's this?

These are configs we use on our projects.

Install

$ yarn add @oakslab/ooo-config --dev

or

$ npm install --save-dev @oakslab/ooo-config

Usage

tsconfig.json

{
  "extends": "@oakslab/ooo-config/common/tsconfig.json",
  // It's also possible to override the rules
  "compilerOptions": {
    "outDir": "dist",
    "lib": ["es2018"]
  },
  "exclude": ["node_modules", "example-folder"]
}

tslint.json

{
  "extends": "@oakslab/ooo-config/common/tslint.json",
  // It's also possible to override the rules
  "linterOptions": {
    "exclude": ["example.js"]
  }
}

.prettierrc.js

Name a configuration file .prettierrc.js and import default config from this package.

module.exports = require("@oakslab/ooo-config/common/.prettierrc");

.jest.config.js

module.exports = require("@oakslab/ooo-config/common/.jest.config");

Package publishing

  1. Bump the version in package.json and commit the changes. For example 0.0.3 --> 0.0.4. This package should follow Semantic Versioning 2.0.0.
  2. Go to Release page and create a new release from the master branch. Provide the same tag version you specified in the previous step. Title and description are also important, let your team members know what has been done in this release.
  3. Publish release and Travis CI does the rest.