es2049package

Version:

ECMAScript 2049 package: zero-configuration libraries and command-line utilies by Harald Rudell

haraldrudell/ECMAScript2049

86 lines (75 loc) • 6.73 kB

Markdown

<h1>ECMAScript 2049 Package</h1> <img src=https://raw.githubusercontent.com/haraldrudell/ECMAScript2049/HEAD/assets/ECMAScript%202049.png alt="ECMAScript 2049" /> ERASE THE PAST &emsp; © <a href=http://haraldrudell.com>Harald Rudell</a> created ECMAScript 2049 in December 2017. ISC License &emsp; This is the es2049package package Repository links: <a href=https://github.com/haraldrudell/ECMAScript2049>ECMAScript 2049</a> the monolithic repository <a href=https://github.com/haraldrudell/ECMAScript2049/tree/master/packages/es2049scripts>es2049scripts</a> providing build-scripts written in ES.Next <a href=https://github.com/haraldrudell/ECMAScript2049/tree/master/packages/allspawn>allspawn</a> async/promise command execution <h2>Benefits</h2> es2049package allows a library or command-line utility to be compiled with only one installed dependency and no configuration files. <h2>Usage</h2> <ol> <li>Add es2049package to your project <blockquote>yarn add es2049package --dev</blockquote></li> <li>Add build to the scripts entry of package.json: <blockquote>"scripts": { &emsp;"build": "rollup --config node:es2049package" …</blockquote></li> <li>Build: <blockquote>yarn build</blockquote></li> </ol> ADVICE <ul> <li>If building a Node.js library, consider newer than default rollup.targets: 6.10, like "targets": {"node": 8}. Ensure proper main, module are set in package.json</li> <li>If writing a command-line executable set rollup.shebang: true and if self-contained "dependencies": false. Possibly use "targets": "mini"</li> <li>It does work, here is a functional <a href=https://github.com/haraldrudell/ECMAScript2049/blob/master/packages/allspawn/package.json>package.json</a></li> <li>If it seems mysterious, use ES2049PACKAGE_DEBUG and possibly ES2049PACKAGE_RESOLVE or ES2049PACKAGE_LOAD as described below</li> </ul> A package.json using es2049package can be found <a href=https://github.com/haraldrudell/ECMAScript2049/blob/master/packages/allspawn/package.json>here</a> <h3>Fields in package.json</h3> Fields used are the rollup key as well as standard top-level keys name, main, module Rollup keys: <ul> <li>input: optional string or array, default src/index.js or src/index.mjs: the entry point used for compilation. If this is an array, it is of objects each describing a compilation with keys: input output dependencies main module external node print shebang targets eslint. Those keys overrides the rollup keys.<ul> <li>main: boolean, default false. use main field as output <li>module: boolean, default false. use module field as output</li> </ul></li> <li>output: optional array or object. A rollup object with file and format (cjs, es) properties. default is according to main or module (or both), if none present it is './build/<package-name>', used for command-line executables</li> <li>external: optional string, array of string: list of packages or filenames that are to be external</li> <li>clean: string or list of strings, desribed below under clean command</li> <li>node: boolean default true. If true, the standard library are added as externals. Should normally be used for all Node.js programs</li> <li>targets: optional string<ul> <li>"stable" Node.js 4.8.1 LTS maintenance</li> <li>"current" The currently executing Node.js</li> <li>a target object as defined by babelJS</li> <li>"mini" indicates Node.js 9+</li> </ul>Default is Node.js 6.10 LTS active.</li> <li>dependencies: optional boolean default true whether dependencies in package.json should be external. Use false if building a self-contained executable.</li> <li>shebang: boolean, default false. If true: the output is an executable, with a shebang line and proper permissions.</li> <li>eslint: boolean, default true if ./.eslintrc.json and ./.eslintrc.yaml are missing. If true: A default eslint configuration based on babel-eslint is provided.</li> </ul> <h3>clean command</h3> Intended to provide a clean command for use with yarn. Clean, when invoked using yarn clean, removes any files or directories provided to it as command-line arguments or if no argments from the rollup.clean field of package.json <blockquote>"rollup": { &emsp;"clean": "bin" …</blockquote> or: <blockquote>"scripts": { &emsp;"clean": "clean lib bin" …</blockquote> <h3>rollup command</h3> The ability to use Rollup although it is a transitive dependency. <h2>Requirements</h2> To develop or compile the ECMAScript 2049 project Yarn 1+ and Node.js current (v8.5+) are required. &emsp; <h2>Troubles</h2> Using environment variables, diagnostic printouts can be reviewed. On Linux, this is like: ES2049PACKAGE_DEBUG=1 $(yarn bin)/rollup --config node:es2049package which prints configuration data and filenames processed by Babel. Additionally, ES2049PACKAGE_RESOLVE prints all resolved import statements, thousands of lines. ES2049PACKAGE_LOAD prints all files included in the bundle, also in the thousands.</li> As of February 2018, eslint has a problem in that configuration extends statements in eslint configuration files are resolved by the eslint path, not the eslint.rc path. Impact is that if es2049package, that holds eslint, is symlinked from an out-of-project-tree location, the extends file may not be found. <a href=https://github.com/eslint/eslint/issues/9904>eslint #9904</a> © <a href=http://haraldrudell.com>Harald Rudell</a> created ECMAScript 2049 in December 2017. ISC License