silvelo/ts-simple

A collection of packages for simplifying your life

ts-simple

A collection of packages for simplifying your life. The most common packages contain simple functions that I used in a lot of my projects. By this way I try to unify that functions in a repository and testing to avoid bugs.

Following DRY philosophy.

Packages

Package	Version	Links
@ts-simple/deep-keys		README.md
@ts-simple/is-pair		README.md
@ts-simple/is-empty		README.md
@ts-simple/str-2-bool		README.md

How to contribution

---

1. Generate package.

• Option 1

  Create new package with lerna.

  lerna create
  

• Option 2

  Convert and exists package to lerna package. More info

Note: In both cases follow the code rules.

2. Configure package.json

• Add public access.

  publishConfig: {
    "access": "public"
  }

• Set correct scripts

  scripts: {
    "tsc": "tsc",
    "test":"test",
    "coverage":"test with coverage"
  }
  

  Note: For test you can use any test framework.

• Add files LICENSE.txt, tsconfig.json, README.md

3. Configure README.md

• Add shield tag comment to your readme to generate travis and coverall shields automatically in build time.

  <!-- START SHIELD -->
  <!-- END SHIELD -->
  

All devDependencies go in root package and try to avoid use externnal dependencies in your's packages.

How to publish

---

The permision to publish librarys is the organization collaborators. (@ts-simple). If your want your package will be include in this scope, you only need a to make a PR.

The members only need to run the script and establish the simver.

npm run badges
npm run lerna:version

Before publish update the badges branch version.

Future

---

Generate core packages to group common functionality in same package and avoid installing multiple packages.