Export true ESM

Option 2 from https://2ality.com/2019/10/hybrid-npm-packages.html.
gouchy · Mar 7, 2022 · dcd91ff · dcd91ff
1 parent 5b4888e
commit dcd91ff
Show file tree

Hide file tree

Showing 31 changed files with 134 additions and 159 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@ out.json
 *.actual.json
 .vscode/
 *.received.*
-dist/
+commonjs/*.js
+esm/
 *.tgz
 *.lock
diff --git a/README.md b/README.md
@@ -11,35 +11,20 @@ Also, keep an eye on [three-dxf](https://github.com/gdsestimating/three-dxf), a
 npm install dxf-parser
 ```
 
-Browsers -- As of 0.1.3 standalone browserify version is in the dist/ folder. Copy it out of the install directory or just download it from the GitHub repo directly. We may evetually publish this to bower, but the build environment needs a little work first.
+Browsers -- As of 0.1.3 standalone browserify version is in the commonjs/ folder. Copy it out of the install directory or just download it from the GitHub repo directly. We may evetually publish this to bower, but the build environment needs a little work first.
 
 #### Usage
 
 ``` js
-import parse, { DxfParser } from 'dxf-parser';
+import DxfParser from 'dxf-parser';
 
 // Grab fileText in node.js or browser
 const fileText = ...;
 
 const parser = new DxfParser();
 try {
-    const dxf = parser.parseSync(fileText);
-}catch(err) {
-    return console.error(err.stack);
-}
-```
-
-or
-
-```ts
-// Grab fileText in node.js or browser
-import parse from 'dxf-parser';
-
-const fileText = ...;
-
-try {
-    const dxf = parse(fileText);
-}catch(err) {
+    const dxf = parser.parse(fileText);
+} catch(err) {
     return console.error(err.stack);
 }
 ```

diff --git a/commonjs/package.json b/commonjs/package.json
@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}
diff --git a/package.json b/package.json
@@ -2,9 +2,14 @@
 	"name": "dxf-parser",
 	"version": "1.1.2",
 	"description": "Parse dxf files into a readable, logical js object.",
-	"main": "./dist/dxf-parser.js",
-	"module": "./dist/index.js",
-	"types": "./dist/index.d.ts",
+	"type": "module",
+	"main": "./commonjs/index.js",
+	"module": "./esm/index.js",
+	"exports": {
+		"import": "./esm/index.js",
+		"require": "./commonjs/index.js"
+	},
+	"types": "./esm/index.d.ts",
 	"scripts": {
 		"test": "mocha --require @babel/register test",
 		"dev": "tsc -w & webpack --mode development",
@@ -46,7 +51,8 @@
 		"reader"
 	],
 	"files": [
-		"dist",
+		"commonjs",
+		"esm",
 		"src"
 	]
 }
diff --git a/samples/browser/index.html b/samples/browser/index.html
@@ -3,7 +3,7 @@
 	<head>
 		<title>Dxf-Parser - Browser Sample</title>
 
-		<script src="../../dist/dxf-parser.js"></script>
+		<script src="../../commonjs/index.js"></script>
 	</head>
 	<body>
 		<input id="file-field" type="file"/>

diff --git a/samples/node/parse-stream.js b/samples/node/parse-stream.js
@@ -1,17 +1,15 @@
-var DxfParser = require('../../dist/dxf-parser');
-var fs = require('fs');
-var path = require('path');
+import DxfParser from '../../esm/index.js'
+import fs from 'fs'
+import path from 'path'
 
-console.log(DxfParser);
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
 
 var DXF_FILE_PATH = path.join(__dirname, '..', 'data', 'api-cw750-details.dxf');
 var OUTPUT_FILE_NAME = "out.json";
 
 var fileStream = fs.createReadStream(DXF_FILE_PATH, { encoding: 'utf8' });
 
 var parser = new DxfParser();
-parser.parseStream(fileStream, function(err, dxf) {
-    if(err) return console.error(err.stack);
-    fs.writeFileSync(OUTPUT_FILE_NAME, JSON.stringify(dxf, null, 3));
-    console.log('Done writing output to ' + OUTPUT_FILE_NAME);
-});
+const dxf = await parser.parseStream(fileStream);
+fs.writeFileSync(OUTPUT_FILE_NAME, JSON.stringify(dxf, null, 3));
+console.log('Done writing output to ' + OUTPUT_FILE_NAME);
diff --git a/samples/node/parse-sync.js b/samples/node/parse-sync.js
@@ -1,6 +1,8 @@
-var DxfParser = require('../../dist/dxf-parser');
-var fs = require('fs');
-var path = require('path');
+import DxfParser from '../../esm/index.js'
+import fs from 'fs'
+import path from 'path'
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
 
 var DXF_FILE_PATH = path.join(__dirname, '..', 'data', 'api-cw750-details.dxf');
 var OUTPUT_FILE_NAME = "out.json";

diff --git a/src/DxfParser.ts b/src/DxfParser.ts
@@ -1,26 +1,26 @@
 import { Readable } from 'stream';
-import DxfArrayScanner, { IGroup } from './DxfArrayScanner';
-import AUTO_CAD_COLOR_INDEX from './AutoCadColorIndex';
-
-import Face from './entities/3dface';
-import Arc from './entities/arc';
-import AttDef from './entities/attdef';
-import Circle from './entities/circle';
-import Dimension from './entities/dimension';
-import Ellipse from './entities/ellipse';
-import Insert from './entities/insert';
-import Line from './entities/line';
-import LWPolyline from './entities/lwpolyline';
-import MText from './entities/mtext';
-import Point from './entities/point';
-import Polyline from './entities/polyline';
-import Solid from './entities/solid';
-import Spline from './entities/spline';
-import Text from './entities/text';
-//import Vertex from './entities/';
+import DxfArrayScanner, { IGroup } from './DxfArrayScanner.js';
+import AUTO_CAD_COLOR_INDEX from './AutoCadColorIndex.js';
+
+import Face from './entities/3dface.js';
+import Arc from './entities/arc.js';
+import AttDef from './entities/attdef.js';
+import Circle from './entities/circle.js';
+import Dimension from './entities/dimension.js';
+import Ellipse from './entities/ellipse.js';
+import Insert from './entities/insert.js';
+import Line from './entities/line.js';
+import LWPolyline from './entities/lwpolyline.js';
+import MText from './entities/mtext.js';
+import Point from './entities/point.js';
+import Polyline from './entities/polyline.js';
+import Solid from './entities/solid.js';
+import Spline from './entities/spline.js';
+import Text from './entities/text.js';
+//import Vertex from './entities/.js';
 
 import log from 'loglevel';
-import IGeometry, { EntityName, IEntity, IPoint } from './entities/geomtry';
+import IGeometry, { EntityName, IEntity, IPoint } from './entities/geomtry.js';
 
 //log.setLevel('trace');
 //log.setLevel('debug');

diff --git a/src/ParseHelpers.ts b/src/ParseHelpers.ts
@@ -1,6 +1,6 @@
-import AUTO_CAD_COLOR_INDEX from './AutoCadColorIndex';
-import DxfArrayScanner, { IGroup } from './DxfArrayScanner';
-import { IEntity, IPoint } from './entities/geomtry';
+import AUTO_CAD_COLOR_INDEX from './AutoCadColorIndex.js';
+import DxfArrayScanner, { IGroup } from './DxfArrayScanner.js';
+import { IEntity, IPoint } from './entities/geomtry.js';
 
 /**
  * Returns the truecolor value of the given AutoCad color index value

diff --git a/src/entities/3dface.ts b/src/entities/3dface.ts
@@ -1,8 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface I3DfaceEntity extends IEntity {
 	shape: boolean;

diff --git a/src/entities/arc.ts b/src/entities/arc.ts
@@ -1,8 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IArcEntity extends IEntity {
 	center: IPoint;

diff --git a/src/entities/attdef.ts b/src/entities/attdef.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IAttdefEntity extends IEntity {
 	scale: number;

diff --git a/src/entities/circle.ts b/src/entities/circle.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface ICircleEntity extends IEntity {
 	center: IPoint;

diff --git a/src/entities/dimension.ts b/src/entities/dimension.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IDimensionEntity extends IEntity{
 	block: string;

diff --git a/src/entities/ellipse.ts b/src/entities/ellipse.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IEllipseEntity extends IEntity {
 	center: IPoint;

diff --git a/src/entities/geomtry.ts b/src/entities/geomtry.ts
@@ -1,4 +1,4 @@
-import DxfArrayScanner, { IGroup } from "../DxfArrayScanner";
+import DxfArrayScanner, { IGroup } from "../DxfArrayScanner.js";
 
 export interface IPoint {
 	x: number;

diff --git a/src/entities/insert.ts b/src/entities/insert.ts
@@ -1,6 +1,6 @@
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IInsertEntity extends IEntity {
 	name: string;

diff --git a/src/entities/line.ts b/src/entities/line.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface ILineEntity extends IEntity{
 	vertices: IPoint[];

diff --git a/src/entities/lwpolyline.ts b/src/entities/lwpolyline.ts
@@ -1,6 +1,6 @@
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IVertex extends IPoint{
 	startWidth: number;

diff --git a/src/entities/mtext.ts b/src/entities/mtext.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IMtextEntity extends IEntity {
 	text: string;

diff --git a/src/entities/point.ts b/src/entities/point.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IPointEntity extends IEntity{
 	position: IPoint;

diff --git a/src/entities/polyline.ts b/src/entities/polyline.ts
@@ -1,8 +1,7 @@
-
-import * as helpers from '../ParseHelpers'
-import VertexParser, { IVertexEntity } from './vertex';
-import IGeometry, { IEntity, IPoint } from './geomtry';
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
+import * as helpers from '../ParseHelpers.js';
+import VertexParser, { IVertexEntity } from './vertex.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
 
 export interface IPolylineEntity extends IEntity {
 	vertices: IVertexEntity[];

diff --git a/src/entities/solid.ts b/src/entities/solid.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface ISolidEntity extends IEntity {
 	points: IPoint[];

diff --git a/src/entities/spline.ts b/src/entities/spline.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface ISplineEntity extends IEntity {
 	controlPoints?: IPoint[];

diff --git a/src/entities/text.ts b/src/entities/text.ts
@@ -1,7 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface ITextEntity extends IEntity {
 	startPoint: IPoint;

diff --git a/src/entities/vertex.ts b/src/entities/vertex.ts
@@ -1,8 +1,6 @@
-
-import DxfArrayScanner, { IGroup } from '../DxfArrayScanner';
-import * as helpers from '../ParseHelpers'
-
-import IGeometry, { IEntity, IPoint } from './geomtry';
+import DxfArrayScanner, { IGroup } from '../DxfArrayScanner.js';
+import * as helpers from '../ParseHelpers.js';
+import IGeometry, { IEntity, IPoint } from './geomtry.js';
 
 export interface IVertexEntity extends IEntity, IPoint{
 	bulge: number;