Add package alfa-string (#1572)

* Factor indent in alfa-string

* Add documentation

* Refactor normalize in alfa-string

* Add new dependency graphs

* Clean up

* Clean up

* Try disabling cache

* Revert

* Add debug info

* Add debug info

* Actually add files

* Clean up

.changeset/eight-dancers-itch.md

@@ -0,0 +1,5 @@
+---
+"@siteimprove/alfa-string": minor
+---
+
+**Added:** Package `@siteimprove/alfa-string` grouping low-level string manipulations is now available.

config/package-dependency-graph.ts

@@ -114,6 +114,7 @@ export default {
         "@siteimprove/alfa-math",
         "@siteimprove/alfa-parser",
         "@siteimprove/alfa-rectangle",
+        "@siteimprove/alfa-string",
         "@siteimprove/alfa-test",
         "@siteimprove/alfa-time",
       ],

docs/review/api/alfa-string.api.md

@@ -0,0 +1,19 @@
+## API Report File for "@siteimprove/alfa-string"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+type String_2 = globalThis.String;
+
+// @public (undocumented)
+namespace String_2 {
+    function indent(input: string): string;
+    function normalize(input: string, toLowerCase?: boolean): string;
+}
+export { String_2 as String }
+
+// (No @packageDocumentation comment for this package)
+
+```

packages/alfa-act/package.json

@@ -39,6 +39,7 @@
     "@siteimprove/alfa-result": "workspace:^0.73.0",
     "@siteimprove/alfa-sarif": "workspace:^0.73.0",
     "@siteimprove/alfa-sequence": "workspace:^0.73.0",
+    "@siteimprove/alfa-string": "workspace:^0.73.0",
     "@siteimprove/alfa-thunk": "workspace:^0.73.0",
     "@siteimprove/alfa-trilean": "workspace:^0.73.0",
     "@siteimprove/alfa-tuple": "workspace:^0.73.0"

packages/alfa-act/src/diagnostic.ts

@@ -1,6 +1,7 @@
 import { Equatable } from "@siteimprove/alfa-equatable";
 import { Hash, Hashable } from "@siteimprove/alfa-hash";
 import { Serializable } from "@siteimprove/alfa-json";
+import { String } from "@siteimprove/alfa-string";
 
 import * as json from "@siteimprove/alfa-json";
 
@@ -11,7 +12,7 @@ export class Diagnostic
   implements Equatable, Hashable, Serializable<Diagnostic.JSON>
 {
   public static of(message: string): Diagnostic {
-    return new Diagnostic(normalize(message));
+    return new Diagnostic(String.normalize(message, false));
   }
 
   protected readonly _message: string;
@@ -58,7 +59,3 @@ export namespace Diagnostic {
 
   export const empty = Diagnostic.of("No extra information");
 }
-
-function normalize(input: string): string {
-  return input.trim().replace(/\s+/g, " ");
-}

packages/alfa-act/tsconfig.json

@@ -36,6 +36,7 @@
     { "path": "../alfa-result" },
     { "path": "../alfa-sarif" },
     { "path": "../alfa-sequence" },
+    { "path": "../alfa-string" },
     { "path": "../alfa-thunk" },
     { "path": "../alfa-trilean" },
     { "path": "../alfa-tuple" }

packages/alfa-aria/package.json

@@ -39,6 +39,7 @@
     "@siteimprove/alfa-selector": "workspace:^0.73.0",
     "@siteimprove/alfa-sequence": "workspace:^0.73.0",
     "@siteimprove/alfa-set": "workspace:^0.73.0",
+    "@siteimprove/alfa-string": "workspace:^0.73.0",
     "@siteimprove/alfa-style": "workspace:^0.73.0",
     "@siteimprove/alfa-table": "workspace:^0.73.0",
     "@siteimprove/alfa-thunk": "workspace:^0.73.0",

packages/alfa-aria/src/node/container.ts

@@ -1,4 +1,5 @@
 import { None, Option } from "@siteimprove/alfa-option";
+import { String } from "@siteimprove/alfa-string";
 
 import * as dom from "@siteimprove/alfa-dom";
 
@@ -62,7 +63,7 @@ export class Container extends Node<"container"> {
   public toString(): string {
     return [
       "container",
-      ...this._children.map((child) => indent(child.toString())),
+      ...this._children.map((child) => String.indent(child.toString())),
     ].join("\n");
   }
 }
@@ -75,7 +76,3 @@ export namespace Container {
     role: Role.Name | null;
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-aria/src/node/element.ts

@@ -2,6 +2,7 @@ import { Iterable } from "@siteimprove/alfa-iterable";
 import { None, Option } from "@siteimprove/alfa-option";
 import { Predicate } from "@siteimprove/alfa-predicate";
 import { Refinement } from "@siteimprove/alfa-refinement";
+import { String } from "@siteimprove/alfa-string";
 
 import * as dom from "@siteimprove/alfa-dom";
 
@@ -110,7 +111,7 @@ export class Element extends Node<"element"> {
         this._role.map((role) => role.name).getOr("element"),
         ...this._name.map((name) => `"${name}"`),
       ].join(" "),
-      ...this._children.map((child) => indent(child.toString())),
+      ...this._children.map((child) => String.indent(child.toString())),
     ].join("\n");
   }
 }
@@ -125,7 +126,3 @@ export namespace Element {
     attributes: Array<Attribute.JSON>;
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-aria/tsconfig.json

@@ -70,6 +70,7 @@
     { "path": "../alfa-selector" },
     { "path": "../alfa-sequence" },
     { "path": "../alfa-set" },
+    { "path": "../alfa-string" },
     { "path": "../alfa-style" },
     { "path": "../alfa-table" },
     { "path": "../alfa-test" },

packages/alfa-dom/package.json

@@ -56,6 +56,7 @@
     "@siteimprove/alfa-sarif": "workspace:^0.73.0",
     "@siteimprove/alfa-selective": "workspace:^0.73.0",
     "@siteimprove/alfa-sequence": "workspace:^0.73.0",
+    "@siteimprove/alfa-string": "workspace:^0.73.0",
     "@siteimprove/alfa-trampoline": "workspace:^0.73.0",
     "@siteimprove/alfa-tree": "workspace:^0.73.0"
   },

packages/alfa-dom/src/node/document.ts

@@ -2,7 +2,9 @@ import { Array } from "@siteimprove/alfa-array";
 import { Device } from "@siteimprove/alfa-device";
 import { Iterable } from "@siteimprove/alfa-iterable";
 import { None, Option } from "@siteimprove/alfa-option";
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
+
 import { Node } from "../node";
 import { Sheet } from "../style/sheet";
 import { Element } from "./element";
@@ -76,7 +78,7 @@ export class Document extends Node<"document"> {
 
   public toString(): string {
     const children = this._children
-      .map((child) => indent(child.toString()))
+      .map((child) => String.indent(child.toString()))
       .join("\n");
 
     return `#document${children === "" ? "" : `\n${children}`}`;
@@ -151,7 +153,3 @@ export namespace Document {
       });
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/node/element.ts

@@ -5,6 +5,7 @@ import { None, Option, Some } from "@siteimprove/alfa-option";
 import { Predicate } from "@siteimprove/alfa-predicate";
 import { Rectangle } from "@siteimprove/alfa-rectangle";
 import { Sequence } from "@siteimprove/alfa-sequence";
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Namespace } from "../namespace";
@@ -341,7 +342,7 @@ export class Element<N extends string = string>
         return value.trim();
       })
       .filter(not(isEmpty))
-      .map(indent)
+      .map(String.indent)
       .join("\n");
 
     return `<${name}${attributes}>${
@@ -519,7 +520,3 @@ export namespace Element {
 
   export const { inputType } = helpers;
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/node/fragment.ts

@@ -1,4 +1,5 @@
 import { Device } from "@siteimprove/alfa-device";
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Iterable } from "@siteimprove/alfa-iterable";
@@ -38,7 +39,7 @@ export class Fragment extends Node<"fragment"> {
 
   public toString(): string {
     const children = this._children
-      .map((child) => indent(child.toString()))
+      .map((child) => String.indent(child.toString()))
       .join("\n");
 
     return `#document-fragment${children === "" ? "" : `\n${children}`}`;
@@ -93,7 +94,3 @@ export namespace Fragment {
       });
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/node/shadow.ts

@@ -1,4 +1,5 @@
 import { None, Option } from "@siteimprove/alfa-option";
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Device } from "@siteimprove/alfa-device";
@@ -100,7 +101,7 @@ export class Shadow extends Node<"shadow"> {
 
   public toString(): string {
     const children = this._children
-      .map((child) => indent(child.toString()))
+      .map((child) => String.indent(child.toString()))
       .join("\n");
 
     return `#shadow-root (${this._mode})${
@@ -184,7 +185,3 @@ export namespace Shadow {
       });
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/style/rule/font-face.ts

@@ -1,3 +1,4 @@
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Block } from "../block";
@@ -36,7 +37,7 @@ export class FontFaceRule extends Rule<"font-face"> {
   public toString(): string {
     const style = this._style.toString();
 
-    return `@font-face {${style === "" ? "" : `\n${indent(style)}\n`}}`;
+    return `@font-face {${style === "" ? "" : `\n${String.indent(style)}\n`}}`;
   }
 }
 
@@ -59,7 +60,3 @@ export namespace FontFaceRule {
     return Trampoline.done(FontFaceRule.of(json.style.map(Declaration.from)));
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/style/rule/keyframe.ts

@@ -1,3 +1,4 @@
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Block } from "../block";
@@ -47,7 +48,7 @@ export class KeyframeRule extends Rule<"keyframe"> {
     const style = this._style.toString();
 
     return `@keyframe ${this._key} {${
-      style === "" ? "" : `\n${indent(style)}\n`
+      style === "" ? "" : `\n${String.indent(style)}\n`
     }}`;
   }
 }
@@ -74,7 +75,3 @@ export namespace KeyframeRule {
     );
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/style/rule/keyframes.ts

@@ -1,3 +1,4 @@
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Rule } from "../rule";
@@ -32,7 +33,7 @@ export class KeyframesRule extends GroupingRule<"keyframes"> {
 
   public toString(): string {
     const rules = this._rules
-      .map((rule) => indent(rule.toString()))
+      .map((rule) => String.indent(rule.toString()))
       .join("\n\n");
 
     return `@keyframes ${this._name} {${rules === "" ? "" : `\n${rules}\n`}}`;
@@ -60,7 +61,3 @@ export namespace KeyframesRule {
     );
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/style/rule/media.ts

@@ -1,6 +1,7 @@
 import { Lexer } from "@siteimprove/alfa-css";
 import { Feature } from "@siteimprove/alfa-css-feature";
 import { Iterable } from "@siteimprove/alfa-iterable";
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Rule } from "../rule";
@@ -36,7 +37,7 @@ export class MediaRule extends ConditionRule<"media"> {
 
   public toString(): string {
     const rules = join(
-      map(this._rules, (rule) => indent(rule.toString())),
+      map(this._rules, (rule) => String.indent(rule.toString())),
       "\n\n",
     );
 
@@ -63,7 +64,3 @@ export namespace MediaRule {
     );
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/style/rule/page.ts

@@ -1,3 +1,4 @@
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Block } from "../block";
@@ -47,7 +48,7 @@ export class PageRule extends Rule<"page"> {
     const style = this._style.toString();
 
     return `@page ${this._selector} {${
-      style === "" ? "" : `\n${indent(style)}\n`
+      style === "" ? "" : `\n${String.indent(style)}\n`
     }}`;
   }
 }
@@ -74,7 +75,3 @@ export namespace PageRule {
     );
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}

packages/alfa-dom/src/style/rule/style.ts

@@ -1,3 +1,4 @@
+import { String } from "@siteimprove/alfa-string";
 import { Trampoline } from "@siteimprove/alfa-trampoline";
 
 import { Block } from "../block";
@@ -57,7 +58,7 @@ export class StyleRule extends Rule<"style"> {
   public toString(): string {
     const style = this._style.toString();
 
-    return `${this._selector} {${style === "" ? "" : `\n${indent(style)}\n`}}`;
+    return `${this._selector} {${style === "" ? "" : `\n${String.indent(style)}\n`}}`;
   }
 }
 
@@ -83,7 +84,3 @@ export namespace StyleRule {
     );
   }
 }
-
-function indent(input: string): string {
-  return input.replace(/^/gm, "  ");
-}