Docs, export utils from ESM package

kurkle · kurkle · commit f63d853c05ed · 2020-02-23T09:18:26.000+02:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+	"typescript.tsdk": "node_modules\\typescript\\lib"
+}
diff --git a/README.md b/README.md
@@ -64,6 +64,8 @@ hsv(244, 100%, 100%, 0.6)
 
 [typedocs](https://kurkle.github.io/color/)
 
+**note** The docs are for the ESM module. UMD module only exports the [default export](https://kurkle.github.io/color/globals.html#_default)
+
 ## Benchmarks
 
 [benchmarks](https://kurkle.github.io/color/dev/bench/)
diff --git a/color.d.ts b/color.d.ts
@@ -36,7 +36,7 @@ export function hexParse(str: string): {
  */
 export function hexString(v: RGBA): string | RGBA;
 /**
- * Rounds to decimal to nearest integer
+ * Rounds decimal to nearest integer
  * @param {number} v - the number to round
  */
 export function round(v: number): number;
@@ -137,9 +137,15 @@ export class Color {
      * @param {Color|RGBA|string|number[]} input
      */
     constructor(input: string | number[] | Color | RGBA);
-    /** @type {RGBA} */
+    /**
+     * @type {RGBA}
+     * @hidden
+     **/
     _rgb: RGBA;
-    /** @type {boolean} */
+    /**
+     * @type {boolean}
+     * @hidden
+     **/
     _valid: boolean;
     /**
      * `true` if this is a valid color
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@kurkle/color",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "css color parsing, manupulation and conversion",
   "main": "dist/color.js",
   "module": "dist/color.esm.js",
diff --git a/packed.js b/packed.js
@@ -45,6 +45,7 @@ function unpack(obj) {
 	return unpacked;
 }
 
+/** @hidden */
 export const names = unpack({
   OiceXe: 'f0f8ff',
   antiquewEte: 'faebd7',
diff --git a/rollup.config.js b/rollup.config.js
@@ -6,6 +6,7 @@ import visualizer from 'rollup-plugin-visualizer';
 import {version, homepage} from './package.json';
 
 const input = 'src/index.js';
+const inputESM = 'src/index.esm.js';
 const banner = `/*!
  * @kurkle/color v${version}
  * ${homepage}
@@ -53,7 +54,7 @@ export default [
 		}
 	},
 	{
-		input: input,
+		input: inputESM,
 		plugins: [
 			cleanup({
 				sourcemap: true
@@ -68,7 +69,7 @@ export default [
 		}
 	},
 	{
-		input: input,
+		input: inputESM,
 		plugins: [
 			terser({
 				output: {
diff --git a/src/byte.js b/src/byte.js
@@ -1,10 +1,10 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 /**
- * Rounds to decimal to nearest integer
+ * Rounds decimal to nearest integer
  * @param {number} v - the number to round
  */
 export function round(v) {
diff --git a/src/hex.js b/src/hex.js
@@ -1,6 +1,6 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 /**
diff --git a/src/hue.js b/src/hue.js
@@ -1,6 +1,6 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 import {b2n, n2p, n2b, p2b} from './byte';
diff --git a/src/index.esm.js b/src/index.esm.js
@@ -0,0 +1,31 @@
+/**
+ * @packageDocumentation
+ * @module index
+ */
+
+import Color from './color';
+
+export {Color};
+export * from './byte';
+export * from './hex';
+export * from './hue';
+export * from './names';
+export * from './rgb';
+
+/**
+ * @typedef {Object} RGBA
+ * @property {number} r - red [0..255]
+ * @property {number} g - green [0..255]
+ * @property {number} b - blue [0..255]
+ * @property {number} a - alpha [0..1]
+ * @internal
+ */
+
+/**
+ * Construct new Color instance
+ * @param {Color|RGBA|string|number[]} input
+ * @internal
+ */
+export default function(input) {
+	return new Color(input);
+}
diff --git a/src/index.js b/src/index.js
@@ -1,4 +1,3 @@
-
 /**
  * @packageDocumentation
  * @module index
@@ -12,11 +11,13 @@ import Color from './color';
  * @property {number} g - green [0..255]
  * @property {number} b - blue [0..255]
  * @property {number} a - alpha [0..1]
+ * @internal
  */
 
 /**
  * Construct new Color instance
  * @param {Color|RGBA|string|number[]} input
+ * @internal
  */
 export default function(input) {
 	return new Color(input);
diff --git a/src/names.js b/src/names.js
@@ -1,6 +1,6 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 import {names} from '../packed';
diff --git a/src/rgb.js b/src/rgb.js
@@ -1,6 +1,6 @@
 /**
  * @packageDocumentation
- * @module helpers
+ * @module utils
  */
 
 import {p2b, b2n} from './byte';
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,7 @@
 {
 	"compilerOptions": {
-		"target": "es6",
-		"module": "es6",
+		"target": "ES6",
+		"module": "ES6",
 		"moduleResolution": "Node",
 		"allowJs": true,
 		"checkJs": true,
@@ -11,21 +11,17 @@
 		"esModuleInterop": true,
 		"noImplicitThis": true
 	},
-	"include": [
-		"./src/index.js"
+	"files": [
+		"./color.d.ts"
 	],
 	"typedocOptions": {
 		"name": "@kurkle/color",
-		"mode": "modules",
-		"excludeExternals": true,
+		"mode": "file",
+
+		"includeDeclarations": true,
+		"exclude": ["./node_modules/**/*"],
+
 		"target": "ES6",
-		"template": "minimal",
-		"includes": [
-			"./src"
-		],
-		"plugins": [
-			"typedoc-plugin-external-module-name",
-		],
-		"out": "./docs"
+		"out": "./docs",
 	},
 }
diff --git a/util/pack.js b/util/pack.js
@@ -153,5 +153,5 @@ function unpack(obj) {
 }
 
 `;
-	fs.writeFileSync('./packed.js', unpack + 'export const names = unpack(' + util.inspect(packed) + ');\n', 'utf-8');
+	fs.writeFileSync('./packed.js', unpack + '/** @hidden */\nexport const names = unpack(' + util.inspect(packed) + ');\n', 'utf-8');
 };

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "typescript.tsdk": "node_modules\\typescript\\lib"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@kurkle/color",`
`3`		`- "version": "0.1.6",`
	`3`	`+ "version": "0.1.7",`
`4`	`4`	`"description": "css color parsing, manupulation and conversion",`
`5`	`5`	`"main": "dist/color.js",`
`6`	`6`	`"module": "dist/color.esm.js",`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ function unpack(obj) {`
`45`	`45`	`return unpacked;`
`46`	`46`	`}`
`47`	`47`
	`48`	`+/** @hidden */`
`48`	`49`	`export const names = unpack({`
`49`	`50`	`OiceXe: 'f0f8ff',`
`50`	`51`	`antiquewEte: 'faebd7',`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import visualizer from 'rollup-plugin-visualizer';`
`6`	`6`	`import {version, homepage} from './package.json';`
`7`	`7`
`8`	`8`	`const input = 'src/index.js';`
	`9`	`+const inputESM = 'src/index.esm.js';`
`9`	`10`	const banner = `/*!
`10`	`11`	`* @kurkle/color v${version}`
`11`	`12`	`* ${homepage}`
`@@ -53,7 +54,7 @@ export default [`
`53`	`54`	`}`
`54`	`55`	`},`
`55`	`56`	`{`
`56`		`- input: input,`
	`57`	`+ input: inputESM,`
`57`	`58`	`plugins: [`
`58`	`59`	`cleanup({`
`59`	`60`	`sourcemap: true`
`@@ -68,7 +69,7 @@ export default [`
`68`	`69`	`}`
`69`	`70`	`},`
`70`	`71`	`{`
`71`		`- input: input,`
	`72`	`+ input: inputESM,`
`72`	`73`	`plugins: [`
`73`	`74`	`terser({`
`74`	`75`	`output: {`