3.0.0

This is a breaking change. Existing code using indent will break when padding in the number for left.

.travis.yml

@@ -4,6 +4,7 @@ node_js:
 install:
   - npm install
 script:
+  - npm run lint
   - npm test
 after_failure: 
   - "cat /home/travis/builds/dolanmiu/docx/npm-debug.log"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docx",
-  "version": "2.1.3",
+  "version": "3.0.0",
   "description": "Generate .docx documents with JavaScript (formerly Office-Clippy)",
   "main": "build/index.js",
   "scripts": {

ts/docx/document/body/body.spec.ts

@@ -1,11 +1,12 @@
 import { assert } from "chai";
-import { Body } from "../../../docx/document/body";
-import { Columns } from "../../../docx/document/body/columns";
-import { DocumentGrid } from "../../../docx/document/body/doc-grid";
-import { PageMargin } from "../../../docx/document/body/page-margin";
-import { PageSize } from "../../../docx/document/body/page-size";
-import { SectionProperties } from "../../../docx/document/body/section-properties";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../../tests/utility";
+import { Body } from "./";
+import { Columns } from "./columns";
+import { DocumentGrid } from "./doc-grid";
+import { PageMargin } from "./page-margin";
+import { PageSize } from "./page-size";
+import { SectionProperties } from "./section-properties";
 
 describe("Body", () => {
     let body: Body;

ts/docx/document/document.spec.ts

@@ -1,6 +1,7 @@
 import { assert, expect } from "chai";
-import * as docx from "../../../docx";
-import { Formatter } from "../../../export/formatter";
+
+import * as docx from "../../";
+import { Formatter } from "../../export/formatter";
 
 describe("Document", () => {
     let document: docx.Document;

ts/docx/paragraph/border.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { ThematicBreak } from "../../../docx/paragraph/border";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { ThematicBreak } from "./border";
 
 describe("Border", () => {
     // TODO: Need tests here

ts/docx/paragraph/indent.ts

@@ -3,22 +3,25 @@ import { XmlAttributeComponent, XmlComponent } from "../xml-components";
 interface IIndentAttributesProperties {
     left?: number;
     hanging?: number;
+    firstLine?: number;
+    start?: number;
+    end?: number;
 }
 
 class IndentAttributes extends XmlAttributeComponent<IIndentAttributesProperties> {
     protected xmlKeys = {
         left: "w:left",
         hanging: "w:hanging",
+        firstLine: "w:firstLine",
+        start: "w:start",
+        end: "w:end",
     };
 }
 
 export class Indent extends XmlComponent {
 
-    constructor(left: number, hanging?: number) {
+    constructor(attrs: object) {
         super("w:ind");
-        this.root.push(new IndentAttributes({
-            left: left,
-            hanging: hanging,
-        }));
+        this.root.push(new IndentAttributes(attrs));
     }
 }

ts/docx/paragraph/index.ts

@@ -134,8 +134,8 @@ export class Paragraph extends XmlComponent {
         return this;
     }
 
-    public indent(start: number, hanging?: number): Paragraph {
-        this.properties.push(new Indent(start, hanging));
+    public indent(attrs: object): Paragraph {
+        this.properties.push(new Indent(attrs));
         return this;
     }
 

ts/docx/paragraph/page-break.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { PageBreak } from "../../../docx/paragraph/page-break";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { PageBreak } from "./page-break";
 
 describe("PageBreak", () => {
     let pageBreak: PageBreak;

ts/docx/paragraph/paragraph.spec.ts

@@ -1,7 +1,8 @@
 import { assert, expect } from "chai";
-import * as docx from "../../../docx";
-import { Formatter } from "../../../export/formatter";
-import { Numbering } from "../../../numbering";
+
+import * as docx from "../../docx";
+import { Formatter } from "../../export/formatter";
+import { Numbering } from "../../numbering";
 
 describe("Paragraph", () => {
     let paragraph: docx.Paragraph;
@@ -145,7 +146,7 @@ describe("Paragraph", () => {
             expect(tree).to.deep.equal({
                 "w:p": [{
                     "w:pPr": [],
-                },{
+                }, {
                     "w:r": [
                         {"w:rPr": []},
                         {"w:br": [{_attr: {"w:type": "page"}}]},
@@ -240,7 +241,7 @@ describe("Paragraph", () => {
 
     describe("#indent", () => {
         it("should set the paragraph indent to the given values", () => {
-            paragraph.indent(720);
+            paragraph.indent({ left: 720 });
             const tree = new Formatter().format(paragraph);
             expect(tree).to.deep.equal({
                 "w:p": [

ts/docx/paragraph/spacing.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
-import { Spacing } from "../../../docx/paragraph/spacing";
-import { Formatter } from "../../../export/formatter";
+
+import { Formatter } from "../../export/formatter";
+import { Spacing } from "./spacing";
 
 describe("Spacing", () => {
     describe("#constructor", () => {

ts/docx/paragraph/style.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { Style } from "../../../docx/paragraph/style";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { Style } from "./style";
 
 describe("ParagraphStyle", () => {
     let style: Style;

ts/docx/paragraph/tab-stop.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { LeftTabStop, MaxRightTabStop } from "../../../docx/paragraph/tab-stop";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { LeftTabStop, MaxRightTabStop } from "./tab-stop";
 
 describe("LeftTabStop", () => {
     let tabStop: LeftTabStop;

ts/docx/paragraph/unordered-list.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { NumberProperties } from "../../../docx/paragraph/unordered-list";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { NumberProperties } from "./unordered-list";
 
 describe("NumberProperties", () => {
     let numberProperties: NumberProperties;

ts/docx/run/break.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { Break } from "../../../docx/run/break";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { Break } from "./break";
 
 describe("Break", () => {
     let currentBreak: Break;

ts/docx/run/run-components/drawing/drawing.spec.ts

@@ -1,7 +1,8 @@
 import { assert } from "chai";
 import * as fs from "fs";
-import { Drawing } from "../../../../docx/run/run-components/drawing";
-import { Utility } from "../../../utility";
+
+import { Utility } from "../../../../tests/utility";
+import { Drawing } from "./";
 
 describe("Drawing", () => {
     let currentBreak: Drawing;

ts/docx/run/run-components/text.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
-import { Text } from "../../../../docx/run/run-components/text";
-import { Formatter } from "../../../../export/formatter";
+
+import { Formatter } from "../../../export/formatter";
+import { Text } from "./text";
 
 describe("Text", () => {
     describe("#constructor", () => {

ts/docx/run/run-fonts.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
-import { RunFonts } from "../../../docx/run/run-fonts";
-import { Formatter } from "../../../export/formatter";
+
+import { Formatter } from "../../export/formatter";
+import { RunFonts } from "./run-fonts";
 
 describe("RunFonts", () => {
 

ts/docx/run/run.spec.ts

@@ -1,7 +1,8 @@
 import { assert, expect } from "chai";
-import { Run } from "../../../docx/run";
-import { Formatter } from "../../../export/formatter";
-import { Utility } from "../../utility";
+
+import { Formatter } from "../../export/formatter";
+import { Utility } from "../../tests/utility";
+import { Run } from "./";
 
 describe("Run", () => {
     let run: Run;

ts/docx/run/script.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { SubScript, SuperScript } from "../../../docx/run/script";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { SubScript, SuperScript } from "./script";
 
 describe("SubScript", () => {
     let subScript: SubScript;

ts/docx/run/strike.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { DoubleStrike, Strike } from "../../../docx/run/formatting";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { DoubleStrike, Strike } from "./formatting";
 
 describe("Strike", () => {
     let strike: Strike;

ts/docx/run/tab.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { Tab } from "../../../docx/run/tab";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { Tab } from "./tab";
 
 describe("Tab", () => {
     let tab: Tab;

ts/docx/run/text-run.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
-import { TextRun } from "../../../docx/run/text-run";
-import { Formatter } from "../../../export/formatter";
+
+import { Formatter } from "../../export/formatter";
+import { TextRun } from "./text-run";
 
 describe("TextRun", () => {
     let run: TextRun;

ts/docx/run/underline.spec.ts

@@ -1,7 +1,8 @@
 import { assert, expect } from "chai";
-import * as u from "../../../docx/run/underline";
-import { Formatter } from "../../../export/formatter";
-import { Utility } from "../../utility";
+
+import { Formatter } from "../../export/formatter";
+import { Utility } from "../../tests/utility";
+import * as u from "./underline";
 
 describe("Underline", () => {
 

ts/docx/table/grid.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
-import { GridCol, TableGrid } from "../../../docx/table/grid";
-import { Formatter } from "../../../export/formatter";
+
+import { Formatter } from "../../export/formatter";
+import { GridCol, TableGrid } from "./grid";
 
 describe("GridCol", () => {
     describe("#constructor", () => {

ts/docx/table/properties.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
-import { TableProperties } from "../../../docx/table/properties";
-import { Formatter } from "../../../export/formatter";
+
+import { Formatter } from "../../export/formatter";
+import { TableProperties } from "./properties";
 
 describe("TableProperties", () => {
     describe("#constructor", () => {

ts/docx/table/table.spec.ts

@@ -1,8 +1,9 @@
 /* tslint:disable:no-unused-expression */
 import { expect } from "chai";
-import { Paragraph } from "../../../docx/paragraph";
-import { Table } from "../../../docx/table";
-import { Formatter } from "../../../export/formatter";
+
+import { Formatter } from "../../export/formatter";
+import { Paragraph } from "../paragraph";
+import { Table } from "./";
 
 describe("Table", () => {
     describe("#constructor", () => {

ts/docx/xml-components/attribute.spec.ts

@@ -1,5 +1,6 @@
 import { assert } from "chai";
-import { Attributes } from "../../../docx/xml-components";
+
+import { Attributes } from "./";
 
 describe("Attribute", () => {
     describe("#constructor()", () => {

ts/docx/xml-components/xml-component.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
-import { XmlComponent } from "../../../docx/xml-components";
-import { Utility } from "../../utility";
+
+import { Utility } from "../../tests/utility";
+import { XmlComponent } from "./";
 
 class TestComponent extends XmlComponent {
 

ts/export/formatter.spec.ts

@@ -1,10 +1,10 @@
 import { assert } from "chai";
 
-import * as docx from "../../docx";
-import { Attributes } from "../../docx/xml-components";
-import { Formatter } from "../../export/formatter";
-import { Properties } from "../../properties";
-import { Utility } from "../utility";
+import * as docx from "../docx";
+import { Attributes } from "../docx/xml-components";
+import { Formatter } from "../export/formatter";
+import { Properties } from "../properties";
+import { Utility } from "../tests/utility";
 
 describe("Formatter", () => {
     let formatter: Formatter;

ts/numbering/index.ts

@@ -35,39 +35,39 @@ export class Numbering extends XmlComponent {
         const abstractNumbering = this.createAbstractNumbering();
 
         abstractNumbering.createLevel(0, "bullet", "•", "left")
-            .addParagraphProperty(new Indent(720, 360))
+            .addParagraphProperty(new Indent({ left: 720, hanging: 360 }))
             .addRunProperty(new RunFonts("Symbol", "default"));
 
         abstractNumbering.createLevel(1, "bullet", "o", "left")
-            .addParagraphProperty(new Indent(1440, 360))
+            .addParagraphProperty(new Indent({ left: 1440, hanging: 360 }))
             .addRunProperty(new RunFonts("Courier New", "default"));
 
         abstractNumbering.createLevel(2, "bullet", "•", "left")
-            .addParagraphProperty(new Indent(2160, 360))
+            .addParagraphProperty(new Indent({ left: 2160, hanging: 360 }))
             .addRunProperty(new RunFonts("Wingdings", "default"));
 
         abstractNumbering.createLevel(3, "bullet", "•", "left")
-            .addParagraphProperty(new Indent(2880, 360))
+            .addParagraphProperty(new Indent({ left: 2880, hanging: 360 }))
             .addRunProperty(new RunFonts("Symbol", "default"));
 
         abstractNumbering.createLevel(4, "bullet", "o", "left")
-            .addParagraphProperty(new Indent(3600, 360))
+            .addParagraphProperty(new Indent({ left: 3600, hanging: 360 }))
             .addRunProperty(new RunFonts("Courier New", "default"));
 
         abstractNumbering.createLevel(5, "bullet", "•", "left")
-            .addParagraphProperty(new Indent(4320, 360))
+            .addParagraphProperty(new Indent({ left: 4320, hanging: 360 }))
             .addRunProperty(new RunFonts("Wingdings", "default"));
 
         abstractNumbering.createLevel(6, "bullet", "•", "left")
-            .addParagraphProperty(new Indent(5040, 360))
+            .addParagraphProperty(new Indent({ left: 5040, hanging: 360 }))
             .addRunProperty(new RunFonts("Symbol", "default"));
 
         abstractNumbering.createLevel(7, "bullet", "o", "left")
-            .addParagraphProperty(new Indent(5760, 360))
+            .addParagraphProperty(new Indent({ left: 5760, hanging: 360 }))
             .addRunProperty(new RunFonts("Courier New", "default"));
 
         abstractNumbering.createLevel(8, "bullet", "•", "left")
-            .addParagraphProperty(new Indent(6480, 360))
+            .addParagraphProperty(new Indent({ left: 6480, hanging: 360 }))
             .addRunProperty(new RunFonts("Wingdings", "default"));
 
         this.createConcreteNumbering(abstractNumbering);

ts/numbering/level.ts

@@ -196,8 +196,8 @@ export class LevelBase extends XmlComponent {
         return this;
     }
 
-    public indent(left: number, hanging?: number): Level {
-        this.addParagraphProperty(new paragraph.Indent(left, hanging));
+    public indent(attrs: object): Level {
+        this.addParagraphProperty(new paragraph.Indent(attrs));
         return this;
     }
 

ts/numbering/numbering.spec.ts

@@ -1,9 +1,9 @@
 import { expect } from "chai";
 import { Formatter } from "../export/formatter";
-import { Numbering } from "../numbering";
-import { AbstractNumbering } from "../numbering/abstract-numbering";
-import { LevelForOverride } from "../numbering/level";
-import { Num } from "../numbering/num";
+import { Numbering } from "./";
+import { AbstractNumbering } from "./abstract-numbering";
+import { LevelForOverride } from "./level";
+import { Num } from "./num";
 
 describe("Numbering", () => {
 
@@ -111,7 +111,7 @@ describe("AbstractNumbering", () => {
             it("#indent", () => {
                 const abstractNumbering = new AbstractNumbering(1);
                 const level = abstractNumbering.createLevel(0, "lowerLetter", "%0.")
-                    .indent(720);
+                    .indent({ left: 720 });
                 const tree = new Formatter().format(level);
                 expect(tree["w:lvl"]).to.include({
                     "w:pPr": [{"w:ind": [{_attr: {"w:left": 720}}]}],

ts/properties/properties.spec.ts

@@ -1,7 +1,7 @@
 import { expect } from "chai";
 
 import { Formatter } from "../export/formatter";
-import { Properties } from "../properties";
+import { Properties } from "./";
 
 describe("Properties", () => {
 

ts/styles/defaults/run-properties.ts

@@ -1,7 +1,7 @@
-import { RunProperties } from "../../docx/run/properties";
-import { XmlComponent } from "../../docx/xml-components";
-import { RunFonts } from "../../docx/run/run-fonts";
 import { Size } from "../../docx/run/formatting";
+import { RunProperties } from "../../docx/run/properties";
+import { RunFonts } from "../../docx/run/run-fonts";
+import { XmlComponent } from "../../docx/xml-components";
 
 export class RunPropertiesDefaults extends XmlComponent {
     private properties: RunProperties;

ts/styles/factory.ts

@@ -1,7 +1,7 @@
 import { Color, Italics, Size } from "../docx/run/formatting";
 
 import { Styles } from "./";
-import { DocumentDefaults } from "./defaults";
+// import { DocumentDefaults } from "./defaults";
 import {
     Heading1Style, Heading2Style, Heading3Style, Heading4Style, Heading5Style, Heading6Style,
     ListParagraph, TitleStyle,

ts/styles/index.ts

@@ -1,7 +1,7 @@
 import { DocumentAttributes } from "../docx/document/document-attributes";
 import { XmlComponent } from "../docx/xml-components";
-import { ParagraphStyle } from "./style";
 import { DocumentDefaults } from "./defaults";
+import { ParagraphStyle } from "./style";
 
 export class Styles extends XmlComponent {
 

ts/styles/style/index.ts

@@ -171,8 +171,8 @@ export class ParagraphStyle extends Style {
         return this;
     }
 
-    public indent(left: number, hanging?: number): ParagraphStyle {
-        this.addParagraphProperty(new paragraph.Indent(left, hanging));
+    public indent(attrs: object): ParagraphStyle {
+        this.addParagraphProperty(new paragraph.Indent(attrs));
         return this;
     }
 

ts/styles/styles.spec.ts

@@ -1,8 +1,8 @@
 import { assert, expect } from "chai";
 import { Formatter } from "../export/formatter";
-import { Styles } from "../styles";
-import { ParagraphStyle, Style } from "../styles/style";
-import * as components from "../styles/style/components";
+import { Styles } from "./";
+import { ParagraphStyle, Style } from "./style";
+import * as components from "./style/components";
 
 describe("Styles", () => {
     let styles: Styles;
@@ -185,7 +185,7 @@ describe("ParagraphStyle", () => {
     describe("formatting methods: paragraph properties", () => {
         it("#indent", () => {
             const style = new ParagraphStyle("myStyleId")
-                .indent(720);
+                .indent({ left: 720 });
             const tree = new Formatter().format(style);
             expect(tree).to.deep.equal({
                 "w:style": [

ts/test-tsconfig.json

@@ -9,5 +9,9 @@
         "sourceRoot": "./",
         "rootDir": "./",
         "module": "commonjs"
-    }
+    },
+    "include": [
+        "**/*.spec.ts",
+        "**/*.d.ts"
+    ]
 }

ts/tests/_testTemplate.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 import { assert } from "chai";
+
 import { Utility } from "./utility";
 /* tslint:enable */
 

ts/tsconfig.json

@@ -12,6 +12,8 @@
         "declaration": true
     },
     "exclude": [
-        "tests"
+        "tests",
+        "**/*.spec.ts",
+        "**/_*"
     ]
 }