README.md

DEPRECATED REPO: This tool has been re-integrated in my monorepo: https://github.com/Offirmo/offirmo-monorepo/tree/master/4-incubator/hello-world-npm

Hello World Emo

A hello world npm module whose real purpose is to experiment a 'modern' (typescript / ES6) module declaration and its consumption by various environments, including legacy.

This is an "emo" version, in reference to this article: JavaScript Modules: Welcome to My Emo Hellscape.

installation

npm i --save hello-world-emo

Then in your code:

• node 6+ : const { hello } = require('hello-world-emo')
• node stable (4): const hello = require('hello-world-emo').hello
• node legacy (<4): var hello = require('hello-world-emo/dist/index.node-legacy').hello
• ES2015/ES6: import { hello } from 'hello-world-emo'
  • a "jsnext" entry is provided in package.json for rollup users, pointing to ES6 code
• typescript: import { hello } from 'hello-world-emo'
• browser
  • TODO

Usage

hello()           --> Hello, World :-(
hello('Offirmo')  --> Hello, Offirmo :-(

What did you expect ?

Contributing

npm 3 is needed for installing deps (node >= 6)

rm -rf node_modules
npm i

tests (node >= 6)

npm run test:quick
npm run test:interactive

Then switch back to the lowest non-legacy node we want to officially support (earlier will be "legacy") for generating

nvm use 4
npm run build

Eventually, commit and release

npm run np -- patch

Technical

This module is aiming at having optimal consumption by :

• node stable, latest and legacy
• browser: vanilla, requireJs, SystemJS...
• ES6
  • mainly for rollup tree-shaking (jsnext)
    • https://github.com/rollup/rollup
• typescript 1 & 2
  • https://www.typescriptlang.org/docs/handbook/modules.html
  • https://blog.oio.de/2014/01/31/an-introduction-to-typescript-module-system/
  • https://github.com/basarat/ts-npm-module-consume
  • http://stackoverflow.com/questions/12687779/how-do-you-produce-a-d-ts-typings-definition-file-from-an-existing-javascript
  • https://www.typescriptlang.org/docs/handbook/writing-declaration-files.html

References :

• https://medium.com/@tarkus/how-to-build-and-publish-es6-modules-today-with-babel-and-rollup-4426d9c7ca71#.5pxa9u2l1
• https://ponyfoo.com/articles/why-i-write-plain-javascript-modules
• http://www.2ality.com/2015/12/bundling-modules-future.html
• https://www.smashingmagazine.com/2016/02/writing-next-generation-reusable-javascript-modules/
• https://medium.com/@mweststrate/how-to-create-strongly-typed-npm-modules-1e1bda23a7f4#.74ko6tal3