@linkiez/dxf-renew 5.3.1

package/README.md

@@ -0,0 +1,306 @@
+[![Build Status](https://travis-ci.org/bjnortier/dxf.svg?branch=master)](https://travis-ci.org/bjnortier/dxf)
+[![semantic-release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+
+# DXF-Renewed
+
+> **⚠️ WARNING: This repository is currently under development and has not been fully tested in production. Use at your own risk.**
+
+DXF parser for node/browser.
+
+Written in **TypeScript** with full type definitions included. Uses modern ES2015+ features and is built with esbuild for optimal performance.
+
+> **Note:** This is a renewed and modernized fork of the original [dxf](https://github.com/skymakerolof/dxf) library, with complete TypeScript migration, enhanced performance, and additional features.
+
+## Version History
+
+**Version 2.0** - Complete rewrite from SAX-style parsing to handle nested references properly (inserts, blocks, etc.)
+
+**Version 3.0** - Adopted [standard JS](https://standardjs.com), ES6 imports, removed Gulp, updated dependencies
+
+**Version 4.x** - Native SVG elements where possible (`<circle />`, `<ellipse />`, etc.)
+
+**Version 5.x (Current)** - Complete TypeScript migration:
+
+- 🎯 Full TypeScript codebase with strict type checking
+- ⚡ Built with esbuild (96% faster than Babel - 18ms vs 447ms)
+- 📦 Modular type system with 22+ separate type files
+- ✅ 100% test coverage maintained (85 tests passing)
+- 🎨 Enhanced SVG rendering with TEXT, MTEXT, and DIMENSION support
+- 📚 Comprehensive type definitions for all DXF entities
+
+## Supported Entities
+
+All major geometric entities are **parsed and rendered to SVG**:
+
+### Fully Supported
+
+- ✅ **LINE** - Straight line segments
+- ✅ **CIRCLE** - Native SVG `<circle />` element
+- ✅ **ARC** - Circular arcs with native SVG paths
+- ✅ **ELLIPSE** - Native SVG `<ellipse />` element
+- ✅ **LWPOLYLINE** - Lightweight polylines with bulges
+- ✅ **POLYLINE** - 2D/3D polylines with vertices
+- ✅ **SPLINE** - B-spline curves (degree 2-3 as Bézier, others interpolated)
+- ✅ **TEXT** - Single-line text with rotation
+- ✅ **MTEXT** - Multi-line text with formatting
+- ✅ **DIMENSION** - Linear, aligned, radial, diameter, and ordinate dimensions
+- ✅ **INSERT** - Block references with transformations
+- ✅ **POINT** - Point entities
+- ✅ **SOLID** - Solid-filled triangles and quadrilaterals
+- ✅ **3DFACE** - 3D face entities
+
+### Parsed (Not Rendered)
+
+- ⚠️ **HATCH** - Parsed but not rendered to SVG
+- ⚠️ **STYLE** - Text styles parsed (colors supported, fonts not applied)
+- ⚠️ **ATTDEF/ATTRIB** - Block attributes parsed
+
+## Getting started
+
+TypeScript example with full type safety:
+
+```typescript
+import { Helper } from '@linkiez/dxf-renew'
+
+const helper = new Helper(dxfString)
+
+// The 1-to-1 object representation of the DXF
+console.log('parsed:', helper.parsed)
+
+// Denormalised blocks inserted with transforms applied
+console.log('denormalised:', helper.denormalised)
+
+// Create an SVG
+console.log('svg:', helper.toSVG())
+
+// Create polylines (e.g. to render in WebGL)
+console.log('polylines:', helper.toPolylines())
+```
+
+JavaScript example:
+
+```javascript
+const { Helper } = require('@linkiez/dxf-renew')
+
+const helper = new Helper(dxfString)
+
+// The 1-to-1 object representation of the DXF
+console.log('parsed:', helper.parsed)
+
+// Denormalised blocks inserted with transforms applied
+console.log('denormalised:', helper.denormalised)
+
+// Create an SVG
+console.log('svg:', helper.toSVG())
+
+// Create polylines (e.g. to render in WebGL)
+console.log('polylines:', helper.toPolylines())
+```
+
+## Running the Examples
+
+There are examples in the `examples/` directory.
+
+Node ES6 (TypeScript). Will write an SVG to `examples/example.es6.svg`:
+
+```bash
+npx tsx examples/example.es6.js
+```
+
+Node ES5. Will write an SVG to `examples/example.es5.svg`:
+
+```bash
+node examples/example.es5.js
+```
+
+Browser. Compile to a browser bundle and open the example webpage:
+
+```bash
+yarn compile
+open examples/dxf.html
+```
+
+## Package Manager
+
+This project uses **Yarn 4** (Berry) as the package manager. Make sure you have Yarn installed:
+
+```bash
+# Install via npm
+npm install -g yarn
+
+# Or via corepack (recommended)
+corepack enable
+```
+
+All npm commands in the documentation can be replaced with yarn equivalents:
+
+- `npm install` → `yarn install` or just `yarn`
+- `npm test` → `yarn test`
+- `npm run compile` → `yarn compile`
+
+## SVG
+
+Geometric elements are fully supported with **native SVG elements** where possible (`<circle />`, `<ellipse/>`, etc.). TEXT, MTEXT, and DIMENSION entities are now fully rendered with proper transformations and formatting.
+
+**SPLINE entities** with degree 2-3 and no weights are converted to native Bézier curves. Other splines are interpolated as polylines.
+
+Here's an example you will find in the functional test output:
+
+![svg example image](https://cloud.githubusercontent.com/assets/57994/17583566/e00f5d78-5fb1-11e6-9030-55686f980e6f.png)
+
+## Interpolation
+
+The library supports outputting DXFs as interpolated polylines for custom rendering (e.g. WebGL) or other applications:
+
+```typescript
+const polylines = helper.toPolylines()
+```
+
+## Command line
+
+There is a command-line utility (courtesy of [@Joge97](https://github.com/Joge97)) for converting DXF files to SVG:
+
+```bash
+yarn global add @linkiez/dxf-renew
+# or
+npm i -g @linkiez/dxf-renew
+
+dxf-to-svg --help
+```
+
+Usage:
+
+```text
+Usage: dxf-to-svg [options] <dxfFile> [svgFile]
+
+Converts a dxf file to a svg file.
+
+Options:
+  -V, --version  output the version number
+  -v --verbose   Verbose output
+  -h, --help     output usage information
+```
+
+## Tests
+
+Running the unit tests:
+
+```bash
+yarn test
+```
+
+Running the functional tests in a browser:
+
+```bash
+yarn test:functional
+```
+
+Please open `toSVG.html` when the file listing loads in the browser (or open `http://localhost:8030/toSVG.html#/`).
+
+## Development Guidelines
+
+- Code patterns and best practices: `docs/CODE_PATTERNS.md`
+
+## TypeScript Support
+
+This library is written in TypeScript and includes full type definitions. All DXF entities, configuration options, and helper methods are fully typed.
+
+Example with type imports:
+
+```typescript
+import { Helper, ParsedDXF, Entity, LineEntity, CircleEntity } from '@linkiez/dxf-renew'
+
+const helper = new Helper(dxfString)
+const parsed: ParsedDXF = helper.parsed
+const entities: Entity[] = helper.denormalised
+
+// Type narrowing
+entities.forEach((entity) => {
+  if (entity.type === 'LINE') {
+    const line = entity as LineEntity
+    console.log(`Line from (${line.start.x}, ${line.start.y}) to (${line.end.x}, ${line.end.y})`)
+  }
+})
+```
+
+## Build System
+
+The project uses **esbuild** for compilation, which is significantly faster than Babel:
+
+- Build time: ~18-22ms (vs 447ms with Babel)
+- 96% performance improvement
+- Full TypeScript support with type checking via `tsc`
+- **Yarn 4** (Berry) as package manager
+
+Build commands:
+
+```bash
+yarn compile        # Compile TypeScript to JavaScript
+yarn type-check     # Run TypeScript type checking
+yarn test           # Run all tests
+```
+
+## Credits
+
+This project is a modernized fork of the original [dxf library by skymakerolof](https://github.com/skymakerolof/dxf), which itself was based on the work by bjnortier and many contributors. DXF-Renewed aims to maintain and improve upon this excellent foundation with modern TypeScript, enhanced performance, and new features.
+
+## Releases
+
+This project uses [semantic-release](https://semantic-release.gitbook.io/) for automated version management and package publishing.
+
+**Releases are automatically created** when commits following [Conventional Commits](https://www.conventionalcommits.org/en/) are pushed to:
+
+- `main` - Stable production releases (`1.0.0`, `1.1.0`, `2.0.0`)
+- `develop` - Pre-releases for testing (`1.1.0-dev.1`, `1.1.0-dev.2`)
+- `beta` - Beta pre-releases (`1.1.0-beta.1`, `1.1.0-beta.2`)
+
+### Commit Format
+
+```bash
+# New feature → MINOR version (1.0.0 → 1.1.0)
+feat(dimension): add DIMSTYLE color support
+
+# Bug fix → PATCH version (1.0.0 → 1.0.1)
+fix(parser): correct POLYLINE parsing
+
+# Breaking change → MAJOR version (1.0.0 → 2.0.0)
+feat!: migrate to pure ESM
+
+BREAKING CHANGE: CommonJS is no longer supported
+```
+
+### Contributing
+
+To contribute:
+
+1. Fork the repository
+2. Make commits using `yarn commit` (interactive) or following Conventional Commits
+3. Push to your fork
+4. Open a Pull Request to `develop`
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidelines and [docs/SEMANTIC_RELEASE.md](./docs/SEMANTIC_RELEASE.md) for release documentation.
+
+## Contributors
+
+### Original dxf Library Contributors
+
+- Liam Mitchell <https://github.com/LiamKarlMitchell>
+- Artur Zochniak <https://github.com/arjamizo>
+- Andy Werner <https://github.com/Gallore>
+- Ivan Baktsheev <https://github.com/apla>
+- Jeff Chen <https://github.com/jeffontheground>
+- Markko Paas <https://github.com/markkopaas>
+- Kim Lokøy <https://github.com/klokoy>
+- Erik Söhnel <https://github.com/hoeck>
+- Teja <https://github.com/hungerpirat>
+- Jakob Pallhuber <https://github.com/Joge97>
+- Eric Mansfield <https://github.com/ericman314>
+- Kristofer <https://github.com/kriffe>
+
+### DXF-Renewed Maintainers
+
+- LiNkIeZ <https://github.com/linkiez>
+
+## License
+
+See LICENSE file for details.

package/build.mjs

@@ -0,0 +1,66 @@
+// esbuild configuration for building the project
+import * as esbuild from 'esbuild'
+import { readdir } from 'node:fs/promises'
+import { join } from 'node:path'
+
+async function getEntryPoints(dir) {
+  const entries = []
+  const stack = [dir]
+
+  while (stack.length) {
+    const currentDir = stack.pop()
+    const dirEntries = await readdir(currentDir, { withFileTypes: true })
+
+    for (const entry of dirEntries) {
+      const fullPath = join(currentDir, entry.name)
+
+      if (entry.isDirectory()) {
+        stack.push(fullPath)
+        continue
+      }
+
+      if (entry.isFile() && (entry.name.endsWith('.ts') || entry.name.endsWith('.js'))) {
+        entries.push(fullPath)
+      }
+    }
+  }
+
+  return entries
+}
+
+async function build() {
+  const entryPoints = await getEntryPoints('src')
+
+  // Build ESM version
+  await esbuild.build({
+    entryPoints,
+    outdir: 'lib',
+    platform: 'node',
+    format: 'esm',
+    target: 'es2020',
+    sourcemap: true,
+    outExtension: { '.js': '.js' },
+    logLevel: 'info',
+  })
+
+  // Build CommonJS version for backwards compatibility
+  await esbuild.build({
+    entryPoints,
+    outdir: 'lib',
+    platform: 'node',
+    format: 'cjs',
+    target: 'es2020',
+    sourcemap: true,
+    outExtension: { '.js': '.cjs' },
+    logLevel: 'info',
+  })
+
+  console.log('✓ Build completed successfully (ESM + CJS)')
+}
+
+try {
+  await build()
+} catch (error) {
+  console.error('Build failed:', error)
+  process.exit(1)
+}

package/commitlint.config.js

@@ -0,0 +1,25 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat',     // New feature
+        'fix',      // Bug fix
+        'docs',     // Documentation only
+        'style',    // Changes that don't affect code meaning (spaces, formatting, etc)
+        'refactor', // Code refactoring that neither adds features nor fixes bugs
+        'perf',     // Performance improvement
+        'test',     // Adding or correcting tests
+        'build',    // Changes to build system or external dependencies
+        'ci',       // Changes to CI files and scripts
+        'chore',    // Other changes that don't modify src or test files
+        'revert'    // Reverts a previous commit
+      ]
+    ],
+    'subject-case': [0], // Allow any capitalization in subject
+    'header-max-length': [2, 'always', 100],
+    'body-max-line-length': [2, 'always', 100]
+  }
+};