Merge pull request #1576 from dolanmiu/feat/cspell

Feat/cspell

.cspell.json

@@ -0,0 +1,58 @@
+// cSpell Settings
+{
+    // Version of the setting file.  Always 0.2
+    "version": "0.2",
+    // language - current active spelling language
+    "language": "en_US",
+    "dictionaries": ["en_US", "typescript", "softwareTerms", "fonts", "npm"],
+    // words - list of words to be always considered correct
+    "words": [
+        "Xmlable",
+        "twip",
+        "twips",
+        "jsonify",
+        "falsey",
+        "aiueo",
+        "iroha",
+        "aiueo",
+        "iroha",
+        "chosung",
+        "Abjad",
+        "Initializable",
+        "rels",
+        "dolan",
+        "xmlify",
+        "Xmlifyed",
+        "xmlified",
+        "datas",
+        "jszip",
+        "rsid",
+        "NUMPAGES",
+        "ATLEAST",
+        "ooxml",
+        "clippy",
+        "docsify"
+    ],
+    "ignoreRegExpList": [
+        "/\"w:.+\"/",
+        "/\"s:.+\"/",
+        "/\"a:.+\"/",
+        "/\"pic:.+\"/",
+        "/\"xmlns:.+\"/",
+        "/\"vt:.+\"/",
+        "/[^\\s]{40,}/",
+        "/<xsd:.+/>/",
+        "/[A-Z_]+ = \".+\"/",
+        "/XmlAttributeComponent<{[^}]+}>/g",
+        "/xmlKeys = {[^}]+}/g",
+        "/\\.to\\.deep\\.equal\\({[^)]+}\\)/g",
+        "\\.to\\.include\\.members\\(\\[[^\\]]+]\\)",
+        "/new [a-zA-Z]+\\({[^£]+}\\)/g"
+    ],
+    "ignorePaths": ["package.json", "docs/api"],
+    "allowCompoundWords": true,
+    // flagWords - list of words to be always considered incorrect
+    // This is useful for offensive words and common spelling errors.
+    // For example "hte" should be "the"
+    "flagWords": ["hte"]
+}

README.md

@@ -26,21 +26,21 @@
 
 Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
 
-*   https://codepen.io/dolanmiu/pen/RwNeObg
+-   https://codepen.io/dolanmiu/pen/RwNeObg
-*   https://jsfiddle.net/dolanmiu/onadx1gu/
+-   https://jsfiddle.net/dolanmiu/onadx1gu/
 
 Here is an example of `docx` working in `Angular`:
 
-*   https://stackblitz.com/edit/angular-docx
+-   https://stackblitz.com/edit/angular-docx
 
 Here is an example of `docx` working in `React`:
 
-*   https://stackblitz.com/edit/react-docx
+-   https://stackblitz.com/edit/react-docx
-*   https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
+-   https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
 
 Here is an example of `docx` working in `Vue.js`:
 
-*   https://stackblitz.com/edit/vuejs-docx
+-   https://stackblitz.com/edit/vuejs-docx
 
 ## Node
 
@@ -48,15 +48,15 @@ Press `endpoint` on the `RunKit` website:
 
 ![RunKit Instructions](https://user-images.githubusercontent.com/2917613/38582539-f84311b6-3d07-11e8-90db-5885ae02c3c4.png)
 
-*   https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
+-   https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
-*   https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
+-   https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
-*   https://runkit.com/dolanmiu/docx-demo3 - Bullet points
+-   https://runkit.com/dolanmiu/docx-demo3 - Bullet points
-*   https://runkit.com/dolanmiu/docx-demo4 - Simple table
+-   https://runkit.com/dolanmiu/docx-demo4 - Simple table
-*   https://runkit.com/dolanmiu/docx-demo5 - Images
+-   https://runkit.com/dolanmiu/docx-demo5 - Images
-*   https://runkit.com/dolanmiu/docx-demo6 - Margins
+-   https://runkit.com/dolanmiu/docx-demo6 - Margins
-*   https://runkit.com/dolanmiu/docx-demo7 - Landscape
+-   https://runkit.com/dolanmiu/docx-demo7 - Landscape
-*   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
+-   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
-*   https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
+-   https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
 
 More [here](https://github.com/dolanmiu/docx/tree/master/demo)
 
@@ -88,7 +88,6 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
 [<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
 [<img src="https://i.imgur.com/AKGhtlh.png" alt="drawing"/>](https://lexense.com/)
 
-
 ...and many more!
 
 ---

demo/10-my-cv.ts

@@ -43,7 +43,7 @@ interface Skill {
     readonly name: string;
 }
 
-interface Achivement {
+interface Achievement {
     readonly issuer: string;
     readonly name: string;
 }
@@ -64,7 +64,7 @@ const experiences: Experience[] = [
     {
         isCurrent: false,
         summary:
-            "Full-stack developer working with Angular, Node and TypeScript. Working for the iShares platform. Emphasis on Dev-ops and developing the continous integration pipeline.",
+            "Full-stack developer working with Angular, Node and TypeScript. Working for the iShares platform. Emphasis on Dev-ops and developing the continuous integration pipeline.",
         title: "Software Developer",
         endDate: {
             month: 11,
@@ -98,6 +98,7 @@ const experiences: Experience[] = [
     {
         isCurrent: false,
         summary:
+            // cspell:disable-next-line
             "Develop web commerce platforms for various high profile clients.\n\nCreated a log analysis web application with the Play Framework in Java, incorporating Test Driven Development. It asynchronously uploads and processes large (2 GB) log files, and outputs meaningful results in context with the problem. \n\nAnalysis  and  development  of  the payment system infrastructure and user accounts section to be used by several clients of the company such as Waitrose, Tally Weijl, DJ Sports, Debenhams, Ann Summers, John Lewis and others.\n\nTechnologies used include WebSphere Commerce, Java, JavaScript and JSP.",
         title: "Java Developer",
         endDate: {
@@ -118,7 +119,7 @@ const education: Education[] = [
     {
         degree: "Master of Science (MSc)",
         fieldOfStudy: "Computer Science",
-        notes: "Exam Results: 1st Class with Distinction, Dissertation: 1st Class with Distinction\n\nRelevant Courses: Java and C# Programming, Software Engineering, Artificial Intelligence, \nComputational Photography, Algorithmics, Architecture and Hardware.\n\nCreated a Windows 8 game in JavaScript for the dissertation. \n\nCreated an award-winning 3D stereoscopic game in C# using XNA.",
+        notes: "Exam Results: 1st Class with Distinction, Dissertation: 1st Class with Distinction\n\nRelevant Courses: Java and C# Programming, Software Engineering, Artificial Intelligence, \nComputational Photography, Algorithms, Architecture and Hardware.\n\nCreated a Windows 8 game in JavaScript for the dissertation. \n\nCreated an award-winning 3D stereoscopic game in C# using XNA.",
         schoolName: "University College London",
         startDate: {
             year: 2012,
@@ -156,7 +157,7 @@ const skills: Skill[] = [
     },
 ];
 
-const achievements: Achivement[] = [
+const achievements: Achievement[] = [
     {
         issuer: "Oracle",
         name: "Oracle Certified Expert",
@@ -165,7 +166,7 @@ const achievements: Achivement[] = [
 
 class DocumentCreator {
     // tslint:disable-next-line: typedef
-    public create([experiences, educations, skills, achivements]: [Experience[], Education[], Skill[], Achivement[]]): Document {
+    public create([experiences, educations, skills, achievements]: [Experience[], Education[], Skill[], Achievement[]]): Document {
         const document = new Document({
             sections: [
                 {
@@ -221,7 +222,7 @@ class DocumentCreator {
                         this.createSubHeading("Skills"),
                         this.createSkillList(skills),
                         this.createSubHeading("Achievements"),
-                        ...this.createAchivementsList(achivements),
+                        ...this.createAchievementsList(achievements),
                         this.createSubHeading("Interests"),
                         this.createInterests("Programming, Technology, Music Production, Web Design, 3D Modelling, Dancing."),
                         this.createHeading("References"),
@@ -318,8 +319,8 @@ class DocumentCreator {
     }
 
     // tslint:disable-next-line:no-any
-    public createAchivementsList(achivements: any[]): Paragraph[] {
+    public createAchievementsList(achievements: any[]): Paragraph[] {
-        return achivements.map(
+        return achievements.map(
             (achievement) =>
                 new Paragraph({
                     text: achievement.name,

demo/11-declaritive-styles-2.ts

@@ -52,18 +52,20 @@ const table = new Table({
 });
 
 const doc = new Document({
-    numbering:{
+    numbering: {
-        config:[{
+        config: [
-            reference: 'ref1',
-            levels: [
             {
-                level: 0,
+                reference: "ref1",
-                format: LevelFormat.DECIMAL,
+                levels: [
-                text: '%1)',
+                    {
-                start: 50,
+                        level: 0,
-            }
+                        format: LevelFormat.DECIMAL,
-            ],
+                        text: "%1)",
-        }]
+                        start: 50,
+                    },
+                ],
+            },
+        ],
     },
     styles: {
         default: {
@@ -184,11 +186,11 @@ const doc = new Document({
                     spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
                     rightTabStop: TabStopPosition.MAX,
                     leftTabStop: 453.543307087,
-                    numbering : {
+                    numbering: {
-                        reference: 'ref1',
+                        reference: "ref1",
                         instance: 0,
                         level: 0,
-                    }
+                    },
                 },
             },
         ],

demo/2-declaritive-styles.ts

@@ -1,4 +1,4 @@
-// Example on how to customise the look at feel using Styles
+// Example on how to customize the look at feel using Styles
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
 import {

demo/21-bookmarks.ts

@@ -1,9 +1,21 @@
 // This demo shows how to create bookmarks then link to them with internal hyperlinks
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Bookmark, Document, Footer, HeadingLevel, InternalHyperlink, Packer, PageBreak, Paragraph, TextRun, PageReference } from "../build";
+import {
+    Bookmark,
+    Document,
+    Footer,
+    HeadingLevel,
+    InternalHyperlink,
+    Packer,
+    PageBreak,
+    Paragraph,
+    TextRun,
+    PageReference,
+} from "../build";
 
 const LOREM_IPSUM =
+    /* cspell:disable-next-line */
     "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mi velit, convallis convallis scelerisque nec, faucibus nec leo. Phasellus at posuere mauris, tempus dignissim velit. Integer et tortor dolor. Duis auctor efficitur mattis. Vivamus ut metus accumsan tellus auctor sollicitudin venenatis et nibh. Cras quis massa ac metus fringilla venenatis. Proin rutrum mauris purus, ut suscipit magna consectetur id. Integer consectetur sollicitudin ante, vitae faucibus neque efficitur in. Praesent ultricies nibh lectus. Mauris pharetra id odio eget iaculis. Duis dictum, risus id pellentesque rutrum, lorem quam malesuada massa, quis ullamcorper turpis urna a diam. Cras vulputate metus vel massa porta ullamcorper. Etiam porta condimentum nulla nec tristique. Sed nulla urna, pharetra non tortor sed, sollicitudin molestie diam. Maecenas enim leo, feugiat eget vehicula id, sollicitudin vitae ante.";
 
 const doc = new Document({

demo/31-tables.ts

@@ -34,8 +34,7 @@ const doc = new Document({
                                 new TableCell({
                                     children: [
                                         new Paragraph({
-                                            text:
+                                            text: "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
-                                                "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
                                             heading: HeadingLevel.HEADING_1,
                                         }),
                                     ],

demo/49-table-borders.ts

@@ -123,8 +123,7 @@ const noBorderTable = new Table({
                 new TableCell({
                     children: [
                         new Paragraph({
-                            text:
+                            text: "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
-                                "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
                             heading: HeadingLevel.HEADING_1,
                         }),
                     ],

demo/51-character-styles.ts

@@ -43,8 +43,7 @@ const doc = new Document({
                             style: "strong",
                         }),
                         new TextRun({
-                            text:
+                            text: " - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
-                                " - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
                         }),
                     ],
                 }),

demo/60-track-revisions.ts

@@ -121,7 +121,7 @@ const doc = new Document({
                                 author: "Firstname Lastname",
                                 date: "2020-10-06T09:05:00Z",
                                 bold: false,
-                            }
+                            },
                         }),
                     ],
                 }),

demo/66-fields.ts

@@ -4,7 +4,7 @@ import * as fs from "fs";
 import { Bookmark, Document, Packer, Paragraph, SimpleField, TextRun } from "../build";
 
 const doc = new Document({
-    creator: 'Me',
+    creator: "Me",
     sections: [
         {
             properties: {},

demo/67-column-break.ts

@@ -13,11 +13,13 @@ const doc = new Document({
                 },
             },
             children: [
-                new Paragraph({ children: [
+                new Paragraph({
-                    new TextRun('This text will be in the first column.'),
+                    children: [
-                    new ColumnBreak(),
+                        new TextRun("This text will be in the first column."),
-                    new TextRun('This text will be in the second column.'),
+                        new ColumnBreak(),
-                ] }),
+                        new TextRun("This text will be in the second column."),
+                    ],
+                }),
             ],
         },
     ],

docs/README.md

@@ -27,24 +27,26 @@ import { Document, Packer, Paragraph, TextRun } from "docx";
 // Documents contain sections, you can have multiple sections per document, go here to learn more about sections
 // This simple example will only contain one section
 const doc = new Document({
-    sections: [{
+    sections: [
-        properties: {},
+        {
-        children: [
+            properties: {},
-            new Paragraph({
+            children: [
-                children: [
+                new Paragraph({
-                    new TextRun("Hello World"),
+                    children: [
-                    new TextRun({
+                        new TextRun("Hello World"),
-                        text: "Foo Bar",
+                        new TextRun({
-                        bold: true,
+                            text: "Foo Bar",
-                    }),
+                            bold: true,
-                    new TextRun({
+                        }),
-                        text: "\tGithub is the best",
+                        new TextRun({
-                        bold: true,
+                            text: "\tGithub is the best",
-                    }),
+                            bold: true,
-                ],
+                        }),
-            }),
+                    ],
-        ],
+                }),
-    }],
+            ],
+        },
+    ],
 });
 
 // Used to export the file into a .docx file
@@ -56,6 +58,7 @@ Packer.toBuffer(doc).then((buffer) => {
 ```
 
 <p align="center">
+<!-- cspell:disable-next-line -->
     <img alt="clippy the assistant" src="./clippy.png">
 </p>
 

docs/_sidebar.md

@@ -1,37 +1,39 @@
-* [Getting Started](/)
+-   [Getting Started](/)
 
-* [Examples](https://github.com/dolanmiu/docx/tree/master/demo)
+-   [Examples](https://github.com/dolanmiu/docx/tree/master/demo)
 
-* API
+-   API
 
-    * [Documentation](https://docx.js.org/api/)
+    -   [Documentation](https://docx.js.org/api/)
 
-* Usage
+-   Usage
 
-	* [Document](usage/document.md)
+    -   [Document](usage/document.md)
-    * [Sections](usage/sections.md)
+        -   [Sections](usage/sections.md)
-	* [Paragraph](usage/paragraph.md)
+    -   [Paragraph](usage/paragraph.md)
-	* [Text](usage/text.md)
+    -   [Text](usage/text.md)
-	* [Image](usage/images.md)
+    -   [Image](usage/images.md)
-	* [Headers & Footers](usage/headers-and-footers.md)
+    -   [Headers & Footers](usage/headers-and-footers.md)
-	* [Bullet Points](usage/bullet-points.md)
+    -   [Bullet Points](usage/bullet-points.md)
-    * [Hyperlinks](usage/hyperlinks.md)
+        -   [Hyperlinks](usage/hyperlinks.md)
-    * [Numbering](usage/numbering.md)
+        -   [Numbering](usage/numbering.md)
-    * [Tables](usage/tables.md)
+        -   [Tables](usage/tables.md)
-	* [Tab Stops](usage/tab-stops.md)
+    -   [Tab Stops](usage/tab-stops.md)
-    * [Table of Contents](usage/table-of-contents.md)
+        -   [Table of Contents](usage/table-of-contents.md)
-    * [Page Numbers](usage/page-numbers.md)
+        -   [Page Numbers](usage/page-numbers.md)
-    * [Change Tracking](usage/change-tracking.md)
+        -   [Change Tracking](usage/change-tracking.md)
-    * [Math](usage/math.md)
+        -   [Math](usage/math.md)
-    * [Text Frames](usage/text-frames.md)
+        -   [Text Frames](usage/text-frames.md)
-	* Styling
+    -   Styling
-        * [Styling with JS](usage/styling-with-js.md)
+        _ [Styling with JS](usage/styling-with-js.md)
-        * [Styling with XML](usage/styling-with-xml.md)
+        _ [Styling with XML](usage/styling-with-xml.md)
-* Exporting
 
-    * [Packers](usage/packers.md)
+-   Exporting
-* Utility
 
-    * [Convenience functions](usage/convenience-functions.md)
+    -   [Packers](usage/packers.md)
 
-* [Contribution Guidelines](contribution-guidelines.md)
+-   Utility
+
+    -   [Convenience functions](usage/convenience-functions.md)
+
+-   [Contribution Guidelines](contribution-guidelines.md)

docs/contribution-guidelines.md

@@ -26,13 +26,15 @@ Please write good commit messages when making a commit: https://chris.beams.io/p
 
 **Do not:**
 
+<!-- cspell:disable -->
 ```
 c // What?
-rtl // Adding acryonyms without explaining anything else is not helpful
+rtl // Adding acronyms without explaining anything else is not helpful
 works! // Glad its working, but the message is not helpful
 demo updated // Getting better, but capitalize the first letter
 Unesesary coment removed // Make sure to use correct spelling
 ```
+<!-- cspell:enable -->
 
 **Do**
 
@@ -42,9 +44,9 @@ Unesesary coment removed // Make sure to use correct spelling
     public float(tableFloatOptions: ITableFloatOptions): Table
 ```
 
-## Delcariative API
+## Declarative API
 
-Make sure the API is declarative, so no _method calling_ or _mutation_. This is a design decision, consistent with the rest of the project. There are benefits to delcariative code over other styles of code, explained here: https://dzone.com/articles/why-declarative-coding-makes-you-a-better-programm
+Make sure the API is declarative, so no _method calling_ or _mutation_. This is a design decision, consistent with the rest of the project. There are benefits to declarative code over other styles of code, explained here: https://dzone.com/articles/why-declarative-coding-makes-you-a-better-programm
 
 **Do not:**
 

docs/usage/numbering.md

@@ -37,7 +37,7 @@ sub-sublists, etc. Each level includes the following properties:
     numbers from each numbering level before this one. Thus a level
     text of `%d)` with a number format of `lowerLetter` would result in
     the sequence "a)", "b)", ...
-*   and a few others, which you can see in the OXML spec section 17.9.6
+*   and a few others, which you can see in the OOXML spec section 17.9.6
 
 ## Document-level bullets/numbering definitions (concrete)
 

docs/usage/styling-with-js.md

@@ -146,7 +146,7 @@ const doc = new Document({
 });
 ```
 
-**Note**: If you are using the `.headingX` or `.title` methods of paragraphs, you must make sure to define `HeadingX` or `Title` styles for these. Otherwise they'll show up unstyled :(. If you are using the `.bullet` or `.setNumbering` methods, you need to define a `ListParagraph` style or the numbers may not show up.
+**Note**: If you are using the `.headingX` or `.title` methods of paragraphs, you must make sure to define `HeadingX` or `Title` styles for these. Otherwise they'll show up un-styled :(. If you are using the `.bullet` or `.setNumbering` methods, you need to define a `ListParagraph` style or the numbers may not show up.
 
 ### Document defaults
 
@@ -199,7 +199,7 @@ For these properties, the rules state the following conflict resolution in case
 
 ## Examples
 
-### Declaritive styles
+### Declarative styles
 
 Importing Images from file system path
 

package.json

@@ -14,8 +14,9 @@
     "webpack": "rimraf ./build && webpack --config ./webpack.config.ts",
     "demo": "npm run build && npm run ts-node --skip-project ./demo",
     "typedoc": "rimraf ./build && typedoc src/index.ts --tsconfig tsconfig.typedoc.json",
-    "style": "prettier -l \"src/**/*.ts\"",
+    "style": "prettier -l \"{src,scripts,demo}/**/*.{ts,html}\"",
     "style.fix": "npm run style -- --write",
+    "cspell": "cspell \"{src,demo,docs,scripts}/**/*.{ts,scss,html,md}\" && cspell \"./*.*\"",
     "fix-types": "ts-node --skip-project scripts/types-absolute-fixer.ts",
     "e2e": "ts-node scripts/e2e.ts",
     "serve.docs": "cd docs && docsify serve",
@@ -73,6 +74,7 @@
     "@types/webpack": "^5.0.0",
     "buffer": "^6.0.3",
     "chai": "^3.5.0",
+    "cspell": "^6.2.2",
     "docsify-cli": "^4.3.0",
     "glob": "^8.0.1",
     "jszip": "^3.1.5",

src/export/packer/next-compiler.ts

@@ -6,7 +6,7 @@ import { File } from "@file/file";
 import { Formatter } from "../formatter";
 import { ImageReplacer } from "./image-replacer";
 import { NumberingReplacer } from "./numbering-replacer";
-import { PrettityType } from "./packer";
+import { PrettifyType } from "./packer";
 
 interface IXmlifyedFile {
     readonly data: string;
@@ -44,7 +44,7 @@ export class Compiler {
         this.numberingReplacer = new NumberingReplacer();
     }
 
-    public compile(file: File, prettifyXml?: boolean | PrettityType): JSZip {
+    public compile(file: File, prettifyXml?: boolean | PrettifyType): JSZip {
         const zip = new JSZip();
         const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml);
         const map = new Map<string, IXmlifyedFile | IXmlifyedFile[]>(Object.entries(xmlifiedFileMapping));
@@ -67,7 +67,7 @@ export class Compiler {
         return zip;
     }
 
-    private xmlifyFile(file: File, prettify?: boolean | PrettityType): IXmlifyedFileMapping {
+    private xmlifyFile(file: File, prettify?: boolean | PrettifyType): IXmlifyedFileMapping {
         const documentRelationshipCount = file.Document.Relationships.RelationshipCount + 1;
 
         const documentXmlData = xml(

src/export/packer/packer.ts

@@ -5,7 +5,7 @@ import { Compiler } from "./next-compiler";
 /**
  * Use blanks to prettify
  */
-export enum PrettityType {
+export enum PrettifyType {
     NONE = "",
     WITH_2_BLANKS = "  ",
     WITH_4_BLANKS = "    ",
@@ -13,7 +13,7 @@ export enum PrettityType {
 }
 
 export class Packer {
-    public static async toBuffer(file: File, prettify?: boolean | PrettityType): Promise<Buffer> {
+    public static async toBuffer(file: File, prettify?: boolean | PrettifyType): Promise<Buffer> {
         const zip = this.compiler.compile(file, prettify);
         const zipData = await zip.generateAsync({
             type: "nodebuffer",
@@ -24,7 +24,7 @@ export class Packer {
         return zipData;
     }
 
-    public static async toBase64String(file: File, prettify?: boolean | PrettityType): Promise<string> {
+    public static async toBase64String(file: File, prettify?: boolean | PrettifyType): Promise<string> {
         const zip = this.compiler.compile(file, prettify);
         const zipData = await zip.generateAsync({
             type: "base64",
@@ -35,7 +35,7 @@ export class Packer {
         return zipData;
     }
 
-    public static async toBlob(file: File, prettify?: boolean | PrettityType): Promise<Blob> {
+    public static async toBlob(file: File, prettify?: boolean | PrettifyType): Promise<Blob> {
         const zip = this.compiler.compile(file, prettify);
         const zipData = await zip.generateAsync({
             type: "blob",

src/file/core-properties/properties.ts

@@ -41,6 +41,7 @@ export interface IPropertiesOptions {
 
 // <xs:element name="coreProperties" type="CT_CoreProperties"/>
 
+/* cSpell:disable */
 // <xs:complexType name="CT_CoreProperties">
 //   <xs:all>
 //     <xs:element name="category" minOccurs="0" maxOccurs="1" type="xs:string"/>
@@ -60,6 +61,7 @@ export interface IPropertiesOptions {
 //     <xs:element name="version" minOccurs="0" maxOccurs="1" type="xs:string"/>
 //   </xs:all>
 // </xs:complexType>
+/* cSpell:enable */
 
 export class CoreProperties extends XmlComponent {
     constructor(options: Omit<IPropertiesOptions, "sections">) {

src/file/document/document-attributes.ts

@@ -1,5 +1,6 @@
 import { XmlAttributeComponent } from "@file/xml-components";
 
+/* cSpell:disable */
 export interface IDocumentAttributesProperties {
     readonly wpc?: string;
     readonly mc?: string;
@@ -41,6 +42,7 @@ export interface IDocumentAttributesProperties {
     readonly w16sdtdh?: string;
     readonly w16se?: string;
 }
+/* cSpell:enable */
 
 export class DocumentAttributes extends XmlAttributeComponent<IDocumentAttributesProperties> {
     protected readonly xmlKeys = {

src/file/paragraph/math/n-ary/index.ts

@@ -1,7 +1,7 @@
 export * from "./math-accent-character";
 export * from "./math-base";
 export * from "./math-limit-location";
-export * from "./math-naray-properties";
+export * from "./math-n-ary-properties";
 export * from "./math-sub-script";
 export * from "./math-sum";
 export * from "./math-super-script";

src/file/paragraph/math/n-ary/math-n-ary-properties.spec.ts

@@ -2,14 +2,14 @@ import { expect } from "chai";
 
 import { Formatter } from "@export/formatter";
 
-import { MathNArayProperties } from "./math-naray-properties";
+import { MathNAryProperties } from "./math-n-ary-properties";
 
-describe("MathNArayProperties", () => {
+describe("MathNAryProperties", () => {
     describe("#constructor()", () => {
-        it("should create a MathNArayProperties with correct root key", () => {
+        it("should create a MathNAryProperties with correct root key", () => {
-            const mathNArayProperties = new MathNArayProperties("∑", true, true);
+            const mathNAryProperties = new MathNAryProperties("∑", true, true);
 
-            const tree = new Formatter().format(mathNArayProperties);
+            const tree = new Formatter().format(mathNAryProperties);
             expect(tree).to.deep.equal({
                 "m:naryPr": [
                     {
@@ -31,9 +31,9 @@ describe("MathNArayProperties", () => {
         });
 
         it("should add super-script hide attributes", () => {
-            const mathNArayProperties = new MathNArayProperties("∑", false, true);
+            const mathNAryProperties = new MathNAryProperties("∑", false, true);
 
-            const tree = new Formatter().format(mathNArayProperties);
+            const tree = new Formatter().format(mathNAryProperties);
             expect(tree).to.deep.equal({
                 "m:naryPr": [
                     {
@@ -62,9 +62,9 @@ describe("MathNArayProperties", () => {
         });
 
         it("should add sub-script hide attributes", () => {
-            const mathNArayProperties = new MathNArayProperties("∑", true, false);
+            const mathNAryProperties = new MathNAryProperties("∑", true, false);
 
-            const tree = new Formatter().format(mathNArayProperties);
+            const tree = new Formatter().format(mathNAryProperties);
             expect(tree).to.deep.equal({
                 "m:naryPr": [
                     {
@@ -93,9 +93,9 @@ describe("MathNArayProperties", () => {
         });
 
         it("should add both super-script and sub-script hide attributes", () => {
-            const mathNArayProperties = new MathNArayProperties("∑", false, false);
+            const mathNAryProperties = new MathNAryProperties("∑", false, false);
 
-            const tree = new Formatter().format(mathNArayProperties);
+            const tree = new Formatter().format(mathNAryProperties);
             expect(tree).to.deep.equal({
                 "m:naryPr": [
                     {

src/file/paragraph/math/n-ary/math-n-ary-properties.ts

@@ -6,7 +6,7 @@ import { MathLimitLocation } from "./math-limit-location";
 import { MathSubScriptHide } from "./math-sub-script-hide";
 import { MathSuperScriptHide } from "./math-super-script-hide";
 
-export class MathNArayProperties extends XmlComponent {
+export class MathNAryProperties extends XmlComponent {
     constructor(accent: string, hasSuperScript: boolean, hasSubScript: boolean) {
         super("m:naryPr");
 

src/file/paragraph/math/n-ary/math-sum.ts

@@ -3,7 +3,7 @@ import { XmlComponent } from "@file/xml-components";
 
 import { MathComponent } from "../math-component";
 import { MathBase } from "./math-base";
-import { MathNArayProperties } from "./math-naray-properties";
+import { MathNAryProperties } from "./math-n-ary-properties";
 import { MathSubScriptElement } from "./math-sub-script";
 import { MathSuperScriptElement } from "./math-super-script";
 
@@ -17,7 +17,7 @@ export class MathSum extends XmlComponent {
     constructor(options: IMathSumOptions) {
         super("m:nary");
 
-        this.root.push(new MathNArayProperties("∑", !!options.superScript, !!options.subScript));
+        this.root.push(new MathNAryProperties("∑", !!options.superScript, !!options.subScript));
 
         if (!!options.subScript) {
             this.root.push(new MathSubScriptElement(options.subScript));

src/file/table/table-properties/table-float-properties.ts

@@ -27,6 +27,7 @@ export enum RelativeVerticalPosition {
 }
 
 export interface ITableFloatOptions {
+    /* cSpell:disable */
     /**
      * Specifies the horizontal anchor or the base object from which the horizontal positioning in the
      * tblpX or tblpXSpec attribute should be determined.
@@ -35,6 +36,7 @@ export interface ITableFloatOptions {
      * text - relative to the vertical edge of the text margin for the column in which the anchor paragraph is located
      * If omitted, the value is assumed to be page.
      */
+    /* cSpell:enable */
     readonly horizontalAnchor?: TableAnchorType;
 
     /**
@@ -90,25 +92,25 @@ export interface ITableFloatOptions {
     readonly relativeVerticalPosition?: RelativeVerticalPosition;
 
     /**
-     * Specifies the minimun distance to be maintained between the table and the top of text in the paragraph
+     * Specifies the minimum distance to be maintained between the table and the top of text in the paragraph
      * below the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
      */
     readonly bottomFromText?: number | string;
 
     /**
-     * Specifies the minimun distance to be maintained between the table and the bottom edge of text in the paragraph
+     * Specifies the minimum distance to be maintained between the table and the bottom edge of text in the paragraph
      * above the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
      */
     readonly topFromText?: number | string;
 
     /**
-     * Specifies the minimun distance to be maintained between the table and the edge of text in the paragraph
+     * Specifies the minimum distance to be maintained between the table and the edge of text in the paragraph
      * to the left of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
      */
     readonly leftFromText?: number | string;
 
     /**
-     * Specifies the minimun distance to be maintained between the table and the edge of text in the paragraph
+     * Specifies the minimum distance to be maintained between the table and the edge of text in the paragraph
      * to the right of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
      */
     readonly rightFromText?: number | string;

src/file/track-revision/track-revision-components/deleted-page-number.spec.ts

@@ -13,7 +13,7 @@ describe("Deleted Page", () => {
     });
 });
 
-describe("Delted NumberOfPages", () => {
+describe("Deleted NumberOfPages", () => {
     describe("#constructor()", () => {
         it("uses the font name for both ascii and hAnsi", () => {
             const tree = new Formatter().format(new DeletedNumberOfPages());

src/file/xml-components/imported-xml-component.ts

@@ -13,8 +13,8 @@ export function convertToXmlComponent(element: XmlElement): ImportedXmlComponent
         case undefined:
         case "element":
             const xmlComponent = new ImportedXmlComponent(element.name as string, element.attributes);
-            const childElments = element.elements || [];
+            const childElements = element.elements || [];
-            for (const childElm of childElments) {
+            for (const childElm of childElements) {
                 const child = convertToXmlComponent(childElm);
                 if (child !== undefined) {
                     xmlComponent.push(child);

src/import-dotx/import-dotx.ts

@@ -141,12 +141,12 @@ export class ImportDotx {
     }
 
     private async addRelationshipToWrapper(
-        relationhipFile: IRelationshipFileInfo,
+        relationshipFile: IRelationshipFileInfo,
         zipContent: JSZip,
         wrapper: HeaderWrapper | FooterWrapper,
         media: Media,
     ): Promise<void> {
-        const refFile = zipContent.files[`word/_rels/${relationhipFile.target}.rels`];
+        const refFile = zipContent.files[`word/_rels/${relationshipFile.target}.rels`];
 
         if (!refFile) {
             return;

src/util/values.spec.ts

@@ -73,6 +73,7 @@ describe("values", () => {
         it("should throw on invalid values", () => {
             expect(() => shortHexNumber("11")).to.throw();
             expect(() => shortHexNumber("112233")).to.throw();
+            /* cspell:disable-next-line */
             expect(() => shortHexNumber("FFFG")).to.throw();
         });
     });

src/util/values.ts

@@ -208,6 +208,7 @@ export const pointMeasureValue = unsignedDecimalNumber;
 //
 // http://www.datypic.com/sc/xsd/t-xsd_dateTime.html
 // The type xsd:dateTime represents a specific date and time in the format
+/* cspell:disable-next-line */
 // CCYY-MM-DDThh:mm:ss.sss, which is a concatenation of the date and time forms,
 // separated by a literal letter "T". All of the same rules that apply to the date
 // and time types are applicable to xsd:dateTime as well.