Giter Site home page Giter Site logo

kunstmaan / snipsonian Goto Github PK

View Code? Open in Web Editor NEW
1.0 15.0 3.0 4.82 MB

Typescript Snippets powered by Kunstmaan Development. Besides typescript source code, also transpiled javascript files are published. We'll add some documentation on how to use the different snippets in the future.

License: ISC License

JavaScript 11.08% TypeScript 81.95% CSS 0.22% SCSS 6.02% Handlebars 0.73%

snipsonian's Introduction

lerna

Snipsonian

Typescript Snippets powered by Kunstmaan Development. Besides typescript source code, also transpiled javascript files are published. We'll add some documentation on how to use the different snippets in the future.

Goal

  • Provide some small re-usable typescript/javascript code snippets that can be used in a variety of javascript projects.
  • Idea is that you just import (es6 syntax) the code snippet(s) you need and bundle it yourself with the rest of your project code (vs. having to include a 'large' concatenated/minified bundle of which you may only need a small part of)

Usage

  1. Add each snipsonian-package that you need by running npm install --save @snipsonian/<packageName>
    • e.g. npm install --save @snipsonian/core for the core package
  2. Import the snippet you need by importing it's /es/ version
    • e.g. import isSet from '@snipsonian/core/es/is/isSet';
    • each such .js snippet will have a related .d.ts file for the typescript types

Development

Installation

  1. install nvm (https://github.com/nvm-sh/nvm) if not installed yet
  2. git clone
  3. switch to correct node version: nvm install (first time) or nvm use (later)
  4. Install top package dependencies: npm install
  5. Link local packages together and install remaining package dependencies: npx lerna bootstrap

Dev commands

npm test

Runs sequentially the linters and the unit tests.

Publish new version

  1. nvm use
  2. execute npm run transpile to transpile the typescript code to .js and .d.ts files under the "/es" and "/cjs" (common js for node) folders (per package)
  3. manually briefly check the generated folders (snipsonian-analytics was previously generated somewhat wrong, but that issue is now fixed !)
  4. switch to the appropriate npm user
  5. execute one of: (see https://github.com/lerna/lerna/tree/master/commands/publish)
    • npx lerna publish = publish packages that have changed since the last release
    • npx lerna publish from-git = explicitly publish packages tagged in the current commit
    • npx lerna publish from-package = explicitly publish packages where the latest version is not present in the registry

License

The ISC License

snipsonian's People

Contributors

dbeerten avatar daanporon avatar vdwjeff avatar bverbist avatar janb87 avatar fvkvn avatar diskwriter avatar

Stargazers

 avatar

Watchers

 avatar Kris Pypen avatar Ruud Denivel avatar Indri Kenens avatar James Cloos avatar Jeroen Thora avatar Bakie avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

snipsonian's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.