tsdraft 0.3.0 → 0.4.0

package/dist/rules.js

@@ -23,6 +23,8 @@ const COLOR = "A layer color must be an AutoCAD Color Index integer from 1 to 25
 const POSITIVE = "This value must be greater than 0";
 const WRITTEN_AS_ZERO = "This value is written as 0, because tsdraft writes 6 decimals. Use 0.000001 or more";
 const TOO_LARGE = "This value must be under 1e100, because AutoCAD reads only two exponent digits from DXF and would take 1e+100 for 1e+10";
+const PAPER_LENGTH = "The paper length must be greater than 0";
+const RATIO = "The ratio must be greater than 0";
 const ARC_LOST = "An arc of nearly a full turn cannot be written: its angles are the same once rounded to 6 decimals, so AutoCAD would hold an arc of no length. Draw a circle instead";
 const TEXT_CONTROL = "Text must be a single line with no control characters";
 const TEXT_PRIVATE_USE = "Text cannot contain the private-use characters U+E800 to U+E8FF, because AutoCAD replaces them when it reads DXF";
@@ -41,6 +43,9 @@ const PATTERN_WRITTEN_AS_ZERO = "A dash or gap of this length is written as 0, b
 const PATTERN_TOTAL = "A linetype pattern's lengths, added up without their signs, must be under 1e100. The total is written too, and AutoCAD reads only two exponent digits from DXF";
 const PATTERN_TYPE = "A linetype's pattern must be an array of finite numbers";
 const DESCRIPTION_LENGTH = "A linetype description cannot be longer than 249 characters, because AutoCAD cuts it there when it reads DXF";
+const ID_EMPTY = "An id cannot be empty";
+const ID_CHARS = "An id can only use the letters A to Z and a to z, digits, ., - and _";
+const ID_LENGTH = "An id cannot be longer than 64 characters";
 const TEXT_PERCENT = 'AutoCAD reads "%%" in text as the start of a control code: it draws "%%d" as a degree sign and "%%%" as one percent sign. The text is stored as written';
 /** Returns what is wrong with a layer name for a DXF version, or undefined when it is valid. */
 export function layerNameProblem(name, version) {
@@ -84,9 +89,9 @@ function nameProblem(name, messages) {
  * layers to AutoCAD and one duplicate name to AUDIT: `ΟΔΟΣ` and `οδος`,
  * `straße` and `strasse`, a composed é and a decomposed one, and a name with
  * and without a soft hyphen. `layerAuditKey` lists the kinds this covers,
- * which are those measured in AutoCAD and not all that AUDIT reports. Names
- * that are one layer to AutoCAD are not this function's concern. The rule
- * compares two names, so it has no type.
+ * which are not all that AUDIT reports. Names that are one layer to AutoCAD
+ * are not this function's concern. The rule compares two names, so it has no
+ * type.
  *
  * @param name - The name of the layer being checked.
  * @param other - The name of another layer in the drawing.
@@ -217,6 +222,29 @@ export function sizeProblem(value) {
         return POSITIVE;
     return written(value) === 0 ? WRITTEN_AS_ZERO : magnitudeProblem(value);
 }
+/**
+ * Returns what is wrong with a paper length, the ratio it plots at, or the
+ * length in drawing units they give, or undefined when the result can be
+ * written. The result is a size, so it is held to the limits of `sizeProblem`.
+ *
+ * @param length - The length on paper, which must be a finite number.
+ * @param ratio - The scale ratio, which must be a finite number.
+ * @param result - The length in drawing units.
+ * @returns The problem, or undefined.
+ */
+export function paperLengthProblem(length, ratio, result) {
+    if (!(length > 0))
+        return PAPER_LENGTH;
+    if (!(ratio > 0))
+        return RATIO;
+    if (written(result) === 0) {
+        return `The result, ${result} drawing units, is written as 0, because tsdraft writes 6 decimals. Use a longer paper length or a larger ratio`;
+    }
+    if (isTooLarge(result)) {
+        return "The result is 1e100 drawing units or more, and AutoCAD reads only two exponent digits from DXF. Use a shorter paper length or a smaller ratio";
+    }
+    return undefined;
+}
 /**
  * Returns what is wrong with the size of a number a drawing holds, or
  * undefined when AutoCAD can read it. This goes for every number that is
@@ -258,6 +286,54 @@ export function arcProblem(startAngle, endAngle) {
 export function arcIsWrittenAsPoint(startAngle, endAngle) {
     return roundsToOneAngle(startAngle, endAngle) && isShortArc(startAngle, endAngle);
 }
+/**
+ * Returns what is wrong with an entity id, or undefined when it is valid. It takes `unknown` so
+ * that `lint` can report a drawing built by hand with an id of the wrong type.
+ */
+export function idProblem(id) {
+    if (typeof id !== "string")
+        return "An id must be a string";
+    if (id.length === 0)
+        return ID_EMPTY;
+    if (!/^[A-Za-z0-9._-]+$/.test(id))
+        return ID_CHARS;
+    return id.length > 64 ? ID_LENGTH : undefined;
+}
+/** The form two ids are compared in: `Door-1` and `door-1` are one id. */
+export function idKey(id) {
+    return id.toLowerCase();
+}
+/**
+ * Returns what is wrong with a second entity that has an id the drawing already has. The rule
+ * depends on the drawing, so it has no type.
+ *
+ * @param id - The id of the second entity.
+ * @param first - The id as the first entity spells it.
+ */
+export function duplicateIdProblem(id, first) {
+    const spelled = first === id ? "" : `, as ${JSON.stringify(first)}`;
+    return `The id ${JSON.stringify(id)} is already used${spelled}. An id names one entity, and ids are compared without regard to case`;
+}
+/** Returns what is wrong with a drawing's format version, or undefined when tsdraft reads it. */
+export function formatProblem(format) {
+    // Negative zero is refused: it would be written as -0, and so change the drawing's JSON.
+    if (Object.is(format, 0))
+        return undefined;
+    return format === undefined
+        ? "The drawing has no format version. A Drawing has format: 0"
+        : `Unknown Drawing format ${shown(format)}. This version of tsdraft reads format 0`;
+}
+/** A value of any type for a message: a string quoted, a number as it is, anything else by kind. */
+export function shown(value) {
+    if (typeof value === "string")
+        return JSON.stringify(value);
+    if (Object.is(value, -0))
+        return "-0";
+    if (typeof value === "number" || typeof value === "boolean" || value == null) {
+        return String(value);
+    }
+    return Array.isArray(value) ? "an array" : `a value of type ${typeof value}`;
+}
 /** Returns what is wrong with a single-line text value, or undefined when it is valid. */
 export function textProblem(value) {
     if (hasControl(value))

package/dist/svg.d.ts

@@ -12,6 +12,7 @@ export interface SvgOptions {
  * Renders a preview SVG. Model Y points up, so the drawing group flips Y. Entities on layers
  * that are off or frozen are left out. Dashed lines are cut into their dashes, scaled by the
  * drawing's linetype scale, and each line is as wide as its lineweight. Each entity's element
- * has its layer in `data-layer` and its index in `drawing.entities` in `data-entity`.
+ * has its layer in `data-layer`, its index in `drawing.entities` in `data-entity`, and its `id`,
+ * when it has one, in `data-id`.
  */
 export declare function toSVG(drawing: Drawing, options?: SvgOptions): string;

package/dist/svg.js

@@ -24,7 +24,8 @@ const MAX_DASHES = 10000;
  * Renders a preview SVG. Model Y points up, so the drawing group flips Y. Entities on layers
  * that are off or frozen are left out. Dashed lines are cut into their dashes, scaled by the
  * drawing's linetype scale, and each line is as wide as its lineweight. Each entity's element
- * has its layer in `data-layer` and its index in `drawing.entities` in `data-entity`.
+ * has its layer in `data-layer`, its index in `drawing.entities` in `data-entity`, and its `id`,
+ * when it has one, in `data-id`.
  */
 export function toSVG(drawing, options = {}) {
     // Keyed as AutoCAD looks layers up, so an entity on `wall` takes the color of layer `WALL`.
@@ -73,7 +74,8 @@ function entityToSvg(e, index, pen, stroke) {
     const width = pen.lineweight === DEFAULT_LINEWEIGHT
         ? ""
         : ` stroke-width="${fmt((stroke * Math.max(pen.lineweight, 5)) / DEFAULT_LINEWEIGHT)}"`;
-    const s = `stroke="${pen.color}"${width} vector-effect="non-scaling-stroke" data-layer="${esc(e.layer)}" data-entity="${index}"`;
+    const mark = `data-layer="${esc(e.layer)}" data-entity="${index}"${e.id === undefined ? "" : ` data-id="${esc(e.id)}"`}`;
+    const s = `stroke="${pen.color}"${width} vector-effect="non-scaling-stroke" ${mark}`;
     if (e.kind !== "text" && pen.dashes) {
         const d = dashedPath(e, pen.dashes);
         // A pattern with a dot draws it as a round cap on a path of no length.
@@ -109,7 +111,7 @@ function entityToSvg(e, index, pen, stroke) {
         case "text": {
             // Undo the group's Y flip so the text reads upright, then apply CAD rotation.
             const t = `translate(${fmt(e.at[0])} ${fmt(e.at[1])}) scale(1 -1)${e.rotation ? ` rotate(${fmt(-e.rotation)})` : ""}`;
-            return `<text transform="${t}" font-size="${fmt(e.height)}" font-family="monospace" fill="${pen.color}" stroke="none" data-layer="${esc(e.layer)}" data-entity="${index}">${esc(e.value)}</text>`;
+            return `<text transform="${t}" font-size="${fmt(e.height)}" font-family="monospace" fill="${pen.color}" stroke="none" ${mark}>${esc(e.value)}</text>`;
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsdraft",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "2D CAD drawings as TypeScript: write the drawing in code, export DXF and SVG.",
   "keywords": [
     "2d",
@@ -47,7 +47,6 @@
     "fmt:check": "oxfmt --check",
     "test": "node --test test/*.test.ts",
     "test:package": "node scripts/package-smoke.ts",
-    "test:cad": "node scripts/cad-check.ts",
     "example": "node examples/site-plan.ts && node examples/outdoor-kitchen.ts",
     "readme:drawing": "node scripts/readme-drawing.ts",
     "verify": "pnpm fmt:check && pnpm lint && pnpm check && pnpm test && pnpm test:package"