@sasjs/lint 5.3.1 → 5.5.0

package/README.md

@@ -29,6 +29,7 @@ Configuration is via a `.sasjslint` file with the following structure (these are
   "ignoredLibnames": [],
   "ignoredMacros": ["webout"],
   "indentationMultiple": 2,
+  "keywordCase": "preserve",
   "lineEndings": "off",
   "lowerCaseFileNames": true,
   "lowerCaseMacroNames": true,
@@ -162,6 +163,14 @@ If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
 }
 ```
 
+### keywordCase
+
+The case the formatter gives SAS keywords. `preserve` leaves them as written, which is what the printer does when nothing is asked of it; `upper` and `lower` rewrite them.
+
+It is a formatting setting rather than a rule - casing is a house style, and reporting it on every line would bury the rules that describe defects - and it takes effect when the formatter is given a layout engine. Every caller with a SAS printer supplies one (`@sasjs/sas-language` is where ours comes from), because the words worth changing are the ones that engine's lexer identifies. Strings and comments are left alone; a name the lexer cannot tell from a keyword - a DATA step variable called `label` - is cased with it.
+
+- Default: preserve
+
 ### hasDoxygenHeader
 
 The SASjs framework recommends the use of Doxygen headers for describing all types of SAS program. This check identifies files where a Doxygen header does not begin on the first line, where it opens with a single asterisk, where it closes with one, where the close shares its line with the header's content, and where the block is never closed. A header is located by its close: the line that holds nothing but `**/`, which is the form `sasjs compile` and this rule set read. A block opened with `/**` whose close sits at the end of a content line, or which has no close at all, is therefore not yet a header.
@@ -333,6 +342,46 @@ In batch mode, long SAS code lines may also be truncated, causing hard-to-detect
 
 We strongly recommend a line length limit, and set the bar at 80. To turn this feature off, set the value to 0.
 
+Saving with the formatter does four things for this rule, in this order.
+
+**It lifts a trailing comment onto its own line** when a line is over the limit and carries code before the comment. The code keeps the line it was on and the comment moves below it at the same indentation, which hands the code to the wrap below and the prose to the reflow - so `, var /* variable name from which to return the format */` becomes two lines, and each is handled by the pass that owns it. The lift happens even when the code alone overruns the limit: each half then reaches the pass that owns it, instead of the line being refused by both.
+
+**It breaks a long line of code** at the last space that still fits, and indents the continuation by the next multiple of [`indentationMultiple`](#indentationmultiple), so a wrap never introduces an indentation warning of its own. A space that follows a `;` is preferred over one inside a statement: the semicolon ends the statement, so a newline there is inert and the line reads as SAS rather than as a slice of one, and for a `put` or `%let` it needs none of the `%trim(` machinery below. It also prefers a space that does not leave a macro keyword such as `%let` or `%then` at the end of the line, and a line is rewritten only when every line it becomes fits the limit - so the pass never trades one warning for another, which also keeps `fixedDiagnosticsCount` from going backwards. The shapes where a break would change what SAS reads, or what another rule parses, are left alone:
+
+- `datalines` / `cards` / `parmcards` records, and the statement that opens them, where a newline ends the record
+- a `%*` comment statement, which is prose
+- any space inside `%str`-family masking or a `%sysfunc` / `%qsysfunc` call, whose argument text is carried as data: measured on a live engine, breaking inside `%sysfunc(fput(...))` wrote `Content-Type:   application/csv` where the macro meant one space
+
+A `put`, `putlog` or `%put` statement (including the `%&var.put` form), the window statements, and a `%let` assignment are broken differently, because a plain newline there is data rather than a delimiter: it is a line of the log for the `put` family, and part of the value for `%let`. The break ends the line with `%trim(` and opens the next with `)`, so the newline and the indentation become the argument of `%trim` - which resolves to nothing - and the blank the break replaced sits after the closing marker:
+
+```sas
+  %put NOTE: the macro could not find the requested%trim(
+    ) table and stopped;
+  %let exp8=MPE_DERIVED:CALLER:VAR_LOGIC may not call%trim(
+    ) a function that;
+```
+
+Leaving the blank at the end of the upper line instead would lose it: measured on a live engine, `requested %trim(` printed `requestedtable`, because SAS drops a blank that sits immediately before a macro call - and a trailing blank is what `noTrailingSpaces` reports anyway. The construct is verified end to end for both forms: a macro holding these statements writes byte-identical log lines, and the `%let` variables hold byte-identical values, before and after a format at a limit of 40 and at 60, several breaks per statement included. A `%let` value built over two statements, and one whose text already carries a `%trim(` of its own, are covered by the same check.
+
+A `%macro` declaration is broken before its parameter commas, and the continuation line starts with the comma, so the parameters read as a list and the declaration stays the one statement the macro rules parse:
+
+```sas
+%macro mf_writefile(fpath
+  ,mode=O,l1=,l2=,l3=,l4=,l5=,l6=,l7=,l8=,l9=,l10=);
+```
+
+**It reflows the prose in a block comment**, paragraph by paragraph: the lines of one paragraph are joined and rewrapped, so the block comes back even rather than ragged. A paragraph breaks at a blank line and before anything line-oriented - an `@li` entry, a `@sasjslint` tag, an `<h4>` heading, a list item, a table row or a macro trigger - and a `@brief` or `@param` line carries the lines under it. Blocks holding a `@example` / `@code` / `@verbatim` body, the `<h4> SAS Macros </h4>` section, a comment that shares a line with code, and a comment inside a `datalines` record are left byte-identical. Prose written with a `*` at the start of every line - the JavaDoc style - is read as a list and left as it is. A reflow normalises the runs of spaces inside the paragraph it rewrites, so two spaces after a full stop become one.
+
+**It raises the file's own exception** for a line neither pass could shorten - a URL in a header, a long quoted literal that generates code, an indented data record - by writing or merging a [`@sasjslint`](#per-file-overrides) block at the end of the header:
+
+```sas
+  @sasjslint {"maxHeaderLineLength": 123}
+```
+
+The value is the exact length the longest such line needs and no more: a header line raises `maxHeaderLineLength`, a data record raises `maxDataLineLength`, and a body line raises `maxLineLength`. An existing exception keeps every key it had, and a value is never lowered.
+
+Nothing is raised for a line whose author can still act on it: a `%*` comment, a `put` whose text holds a word longer than the limit, a `%macro` declaration whose single parameter is too long, or a comment line that a reflow cannot fit. Excusing one of those would relax `maxLineLength` for every line of code in the file, and each is a line the author can rewrite.
+
 - Default: 80
 - Severity: WARNING
 
@@ -690,6 +739,9 @@ We've already implemented the following rules:
 - Remove unused macros from the `<h4> SAS Macros </h4>` section
 - Remove trailing spaces
 - Fix line endings, including adding a missing final newline when [`lineEndings`](#lineendings) is configured
+- Break a line that exceeds [`maxLineLength`](#maxlinelength) at whitespace, where doing so cannot change what SAS reads
+- Reflow the prose in a block comment, paragraph by paragraph
+- Raise the file's own `@sasjslint` exception for a line neither of the above can shorten
 
 The formatter only fixes rules that are in your configuration, so a rule that is off neither warns nor is repaired.
 

package/format/adjustLineLength.d.ts

@@ -0,0 +1,34 @@
+import { LintConfig } from '../types';
+/**
+ * Raises the file's own `@sasjslint` exception so that the lines the passes
+ * could not shorten stop being reported.
+ *
+ * The formatter can break most long lines, and `reflowComments` can reflow
+ * prose, but a single token wider than the limit - a URL in a header, a long
+ * quoted literal that generates code - cannot be shortened at all, and a data
+ * record is not code. The documented way to accept those is the per-file
+ * override, and projects do it by hand today (sasjs/core carries
+ * `{"maxLineLength": 123}` for one documentation URL). This writes it for them,
+ * at the exact length the longest such line needs and no more:
+ *
+ * - a header line raises `maxHeaderLineLength`, which affects header lines only
+ * - a data record raises `maxDataLineLength`, which affects records only
+ * - a body line raises `maxLineLength`, which affects the whole file
+ *
+ * Lines the wrapper declines on purpose - `put`-family statements, where a
+ * break is an extra line of output, and `%macro` / `%mend` declarations - do NOT
+ * raise the limit: they are fixable by hand, and excusing them would hide the
+ * finding for good.
+ *
+ * The value is never lowered, an existing exception keeps every key it had, and
+ * no header means nowhere to write, in which case the text is returned
+ * untouched.
+ *
+ * @param {string} text - the text to adjust.
+ * @param {LintConfig} configuration - the effective configuration, the file's
+ *   own override included.
+ * @returns {string} the text, with its exception raised when one is needed.
+ */
+export declare const adjustLineLength: (text: string, configuration: LintConfig) => string;
+/** The configured line ending, for the rare case a terminator has to be invented. */
+export declare const lineEndingOf: (configuration: LintConfig) => string;

package/format/adjustLineLength.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lineEndingOf = exports.adjustLineLength = void 0;
+const LineEndings_1 = require("../types/LineEndings");
+const getDataSectionsDetail_1 = require("../utils/getDataSectionsDetail");
+const getHeaderLinesCount_1 = require("../utils/getHeaderLinesCount");
+const parseLintOverride_1 = require("../utils/parseLintOverride");
+const scanLine_1 = require("../utils/scanLine");
+const longLines_1 = require("./longLines");
+const rewrapText_1 = require("./rewrapText");
+/** The line that carries a file's own lint configuration. */
+const overrideTag = /^(\s*)@sasjslint\s*(\{.*\})\s*$/;
+/**
+ * Raises the file's own `@sasjslint` exception so that the lines the passes
+ * could not shorten stop being reported.
+ *
+ * The formatter can break most long lines, and `reflowComments` can reflow
+ * prose, but a single token wider than the limit - a URL in a header, a long
+ * quoted literal that generates code - cannot be shortened at all, and a data
+ * record is not code. The documented way to accept those is the per-file
+ * override, and projects do it by hand today (sasjs/core carries
+ * `{"maxLineLength": 123}` for one documentation URL). This writes it for them,
+ * at the exact length the longest such line needs and no more:
+ *
+ * - a header line raises `maxHeaderLineLength`, which affects header lines only
+ * - a data record raises `maxDataLineLength`, which affects records only
+ * - a body line raises `maxLineLength`, which affects the whole file
+ *
+ * Lines the wrapper declines on purpose - `put`-family statements, where a
+ * break is an extra line of output, and `%macro` / `%mend` declarations - do NOT
+ * raise the limit: they are fixable by hand, and excusing them would hide the
+ * finding for good.
+ *
+ * The value is never lowered, an existing exception keeps every key it had, and
+ * no header means nowhere to write, in which case the text is returned
+ * untouched.
+ *
+ * @param {string} text - the text to adjust.
+ * @param {LintConfig} configuration - the effective configuration, the file's
+ *   own override included.
+ * @returns {string} the text, with its exception raised when one is needed.
+ */
+const adjustLineLength = (text, configuration) => {
+    if (!text)
+        return text;
+    if (!configuration.lineLintRules.some((rule) => rule.name === 'maxLineLength'))
+        return text;
+    const headerLinesCount = (0, getHeaderLinesCount_1.getHeaderLinesCount)(text, configuration);
+    if (!headerLinesCount)
+        return text;
+    const entries = (0, rewrapText_1.splitWithTerminators)(text);
+    const lines = entries.map((entry) => entry.line);
+    const dataSections = (0, getDataSectionsDetail_1.getDataSectionsDetail)(text, configuration);
+    const headerLimit = Math.max(configuration.maxLineLength, configuration.maxHeaderLineLength);
+    const dataLimit = Math.max(configuration.maxLineLength, configuration.maxDataLineLength);
+    const needed = {
+        maxLineLength: 0,
+        maxHeaderLineLength: 0,
+        maxDataLineLength: 0
+    };
+    let state = (0, scanLine_1.cleanState)();
+    let breakAwareOpen = false;
+    lines.forEach((line, index) => {
+        const isHeader = index < headerLinesCount;
+        const isData = (0, getDataSectionsDetail_1.checkIsDataLine)(dataSections, index);
+        // A data record is data, so it is not scanned: a comment marker or an
+        // apostrophe in one would otherwise stay open for the rest of the file, and
+        // every later line would read as a comment that no pass may touch.
+        const scanned = isData ? (0, scanLine_1.noScan)() : (0, scanLine_1.scanLine)(line, state);
+        state = scanned.endState;
+        const breakAware = isData
+            ? { line: false, open: false }
+            : (0, longLines_1.breakAwareState)(scanned.code, breakAwareOpen);
+        breakAwareOpen = breakAware.open;
+        const limit = isData
+            ? dataLimit
+            : isHeader
+                ? headerLimit
+                : configuration.maxLineLength;
+        if (line.length <= limit)
+            return;
+        if (breakAware.line ||
+            longLines_1.macroComment.test(line) ||
+            longLines_1.macroDeclaration.test(line))
+            return;
+        // A comment carries no key of its own, so excusing one would raise the
+        // limit for every line of code in the file: `reflowComments` has already
+        // reflowed the prose, and a paragraph holding a word it cannot fit - a URL -
+        // is left to its author. A header line is the exception, because
+        // `maxHeaderLineLength` scopes the relaxation to the header.
+        //
+        // The guard turns on what makes the line long, not on the comment being
+        // there: a line of code that overruns the limit on its own, with a comment
+        // after it, is excused like any other, because no pass may break it either.
+        const codeEnd = scanned.code.trimEnd().length;
+        if (!isHeader && !isData && scanned.hasComment && codeEnd <= limit)
+            return;
+        const key = isData
+            ? 'maxDataLineLength'
+            : isHeader
+                ? 'maxHeaderLineLength'
+                : 'maxLineLength';
+        needed[key] = Math.max(needed[key], line.length);
+    });
+    const raised = Object.keys(needed).filter((key) => needed[key] > configuration[key]);
+    if (!raised.length)
+        return text;
+    const override = (0, parseLintOverride_1.getLintOverride)(text, configuration);
+    const existing = lines
+        .slice(0, headerLinesCount)
+        .find((line) => overrideTag.test(line));
+    // A tag that does not parse is reported by the linter and belongs to its
+    // author: rewriting it would discard whatever they were trying to say.
+    if (existing && !override)
+        return text;
+    const merged = Object.assign({}, (override !== null && override !== void 0 ? override : {}));
+    raised.forEach((key) => {
+        var _a;
+        merged[key] = Math.max((_a = merged[key]) !== null && _a !== void 0 ? _a : 0, needed[key]);
+    });
+    const json = '{' +
+        Object.keys(merged)
+            .map((key) => `"${key}": ${JSON.stringify(merged[key])}`)
+            .join(', ') +
+        '}';
+    if (existing) {
+        const match = overrideTag.exec(existing);
+        if (match[2] === json)
+            return text;
+        const at = lines.indexOf(existing);
+        const rewritten = [...lines];
+        rewritten[at] = `${match[1]}@sasjslint ${json}`;
+        return rewritten.map((line, index) => line + entries[index].ending).join('');
+    }
+    // No exception yet: write one as the last content line of the header, which
+    // is where sasjs/core keeps them, so the header's own layout is untouched.
+    const closingIndex = headerLinesCount - 1;
+    const closing = lines[closingIndex];
+    if (!/^\s*[*]{2}\/\s*$/.test(closing))
+        return text;
+    const previous = lines[closingIndex - 1];
+    const indent = /^\s*/.exec(previous)[0] || '  ';
+    const ending = entries[closingIndex].ending || (0, exports.lineEndingOf)(configuration);
+    const separator = previous.trim() === '' ? [] : [''];
+    const inserted = [...separator, `${indent}@sasjslint ${json}`];
+    const out = lines
+        .slice(0, closingIndex)
+        .map((line, index) => line + entries[index].ending);
+    inserted.forEach((line) => out.push(line + ending));
+    lines.slice(closingIndex).forEach((line, index) => {
+        out.push(line + entries[closingIndex + index].ending);
+    });
+    return out.join('');
+};
+exports.adjustLineLength = adjustLineLength;
+/** The configured line ending, for the rare case a terminator has to be invented. */
+const lineEndingOf = (configuration) => configuration.lineEndings === LineEndings_1.LineEndings.CRLF ? '\r\n' : '\n';
+exports.lineEndingOf = lineEndingOf;
+//# sourceMappingURL=adjustLineLength.js.map

package/format/adjustLineLength.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adjustLineLength.js","sourceRoot":"","sources":["../../src/format/adjustLineLength.ts"],"names":[],"mappings":";;;AACA,sDAAkD;AAClD,0EAGuC;AACvC,sEAAkE;AAClE,kEAA4D;AAC5D,gDAAgE;AAChE,2CAA6E;AAC7E,6CAAmD;AAEnD,6DAA6D;AAC7D,MAAM,WAAW,GAAG,iCAAiC,CAAA;AAKrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,MAAM,gBAAgB,GAAG,CAC9B,IAAY,EACZ,aAAyB,EACjB,EAAE;IACV,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAA;IAEtB,IACE,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,eAAe,CAAC;QAE1E,OAAO,IAAI,CAAA;IAEb,MAAM,gBAAgB,GAAG,IAAA,yCAAmB,EAAC,IAAI,EAAE,aAAa,CAAC,CAAA;IACjE,IAAI,CAAC,gBAAgB;QAAE,OAAO,IAAI,CAAA;IAElC,MAAM,OAAO,GAAG,IAAA,iCAAoB,EAAC,IAAI,CAAC,CAAA;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAChD,MAAM,YAAY,GAAG,IAAA,6CAAqB,EAAC,IAAI,EAAE,aAAa,CAAC,CAAA;IAC/D,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAC1B,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,mBAAmB,CAClC,CAAA;IACD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CACxB,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,iBAAiB,CAChC,CAAA;IACD,MAAM,MAAM,GAAmC;QAC7C,aAAa,EAAE,CAAC;QAChB,mBAAmB,EAAE,CAAC;QACtB,iBAAiB,EAAE,CAAC;KACrB,CAAA;IACD,IAAI,KAAK,GAAG,IAAA,qBAAU,GAAE,CAAA;IACxB,IAAI,cAAc,GAAG,KAAK,CAAA;IAE1B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5B,MAAM,QAAQ,GAAG,KAAK,GAAG,gBAAgB,CAAA;QACzC,MAAM,MAAM,GAAG,IAAA,uCAAe,EAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QAEnD,sEAAsE;QACtE,4EAA4E;QAC5E,mEAAmE;QACnE,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,IAAA,iBAAM,GAAE,CAAC,CAAC,CAAC,IAAA,mBAAQ,EAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QACzD,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAA;QAExB,MAAM,UAAU,GAAG,MAAM;YACvB,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE;YAC9B,CAAC,CAAC,IAAA,2BAAe,EAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;QACjD,cAAc,GAAG,UAAU,CAAC,IAAI,CAAA;QAChC,MAAM,KAAK,GAAG,MAAM;YAClB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,QAAQ;gBACR,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,aAAa,CAAC,aAAa,CAAA;QAEjC,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK;YAAE,OAAM;QAChC,IACE,UAAU,CAAC,IAAI;YACf,wBAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YACvB,4BAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;YAE3B,OAAM;QAER,uEAAuE;QACvE,yEAAyE;QACzE,6EAA6E;QAC7E,iEAAiE;QACjE,6DAA6D;QAC7D,EAAE;QACF,wEAAwE;QACxE,2EAA2E;QAC3E,4EAA4E;QAC5E,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAA;QAC7C,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,IAAI,KAAK;YAAE,OAAM;QAE1E,MAAM,GAAG,GAAc,MAAM;YAC3B,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,QAAQ;gBACR,CAAC,CAAC,qBAAqB;gBACvB,CAAC,CAAC,eAAe,CAAA;QAErB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAClD,CAAC,CAAC,CAAA;IAEF,MAAM,MAAM,GAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC,MAAM,CACxD,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAC1C,CAAA;IAED,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IAE/B,MAAM,QAAQ,GAAG,IAAA,mCAAe,EAAC,IAAI,EAAE,aAAa,CAAC,CAAA;IACrD,MAAM,QAAQ,GAAG,KAAK;SACnB,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC;SAC1B,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAEzC,yEAAyE;IACzE,uEAAuE;IACvE,IAAI,QAAQ,IAAI,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAA;IAEtC,MAAM,MAAM,qBAAQ,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CAAE,CAAA;IACtC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;;QACrB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAA,MAAM,CAAC,GAAG,CAAC,mCAAI,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;IACvD,CAAC,CAAC,CAAA;IACF,MAAM,IAAI,GACR,GAAG;QACH,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aAChB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;aACxD,IAAI,CAAC,IAAI,CAAC;QACb,GAAG,CAAA;IAEL,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAE,CAAA;QACzC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO,IAAI,CAAA;QAElC,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAClC,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,CAAA;QAC5B,SAAS,CAAC,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,cAAc,IAAI,EAAE,CAAA;QAE/C,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC9E,CAAC;IAED,4EAA4E;IAC5E,2EAA2E;IAC3E,MAAM,YAAY,GAAG,gBAAgB,GAAG,CAAC,CAAA;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,CAAA;IAEnC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,OAAO,IAAI,CAAA;IAElD,MAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;IAChD,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,MAAM,IAAI,IAAA,oBAAY,EAAC,aAAa,CAAC,CAAA;IAC1E,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IACpD,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,EAAE,GAAG,MAAM,cAAc,IAAI,EAAE,CAAC,CAAA;IAE9D,MAAM,GAAG,GAAa,KAAK;SACxB,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC;SACtB,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAA;IAErD,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC,CAAA;IAEnD,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAChD,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,YAAY,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,CAAA;IACvD,CAAC,CAAC,CAAA;IAEF,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACrB,CAAC,CAAA;AA/IY,QAAA,gBAAgB,oBA+I5B;AAED,qFAAqF;AAC9E,MAAM,YAAY,GAAG,CAAC,aAAyB,EAAU,EAAE,CAChE,aAAa,CAAC,WAAW,KAAK,yBAAW,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;AADnD,QAAA,YAAY,gBACuC"}

package/format/formatFile.d.ts

@@ -1,9 +1,11 @@
 import { FormatResult } from '../types';
 import { LintConfig } from '../types/LintConfig';
+import { FormatOptions } from '../types/FormatOptions';
 /**
  * Applies automatic formatting to the file at the given path.
  * @param {string} filePath - the path to the file to be formatted.
  * @param {LintConfig} configuration - an optional configuration. When not passed in, this is read from the .sasjslint file.
+ * @param {FormatOptions} options - an optional layout engine, used for the reprint pass.
  * @returns {Promise<FormatResult>} Resolves successfully when the file has been formatted.
  */
-export declare const formatFile: (filePath: string, configuration?: LintConfig) => Promise<FormatResult>;
+export declare const formatFile: (filePath: string, configuration?: LintConfig, options?: FormatOptions) => Promise<FormatResult>;

package/format/formatFile.js

@@ -12,21 +12,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatFile = void 0;
 const file_1 = require("@sasjs/utils/file");
 const lint_1 = require("../lint");
-const parseLintOverride_1 = require("../utils/parseLintOverride");
 const getLintConfig_1 = require("../utils/getLintConfig");
-const shared_1 = require("./shared");
+const formatText_1 = require("./formatText");
 /**
  * Applies automatic formatting to the file at the given path.
  * @param {string} filePath - the path to the file to be formatted.
  * @param {LintConfig} configuration - an optional configuration. When not passed in, this is read from the .sasjslint file.
+ * @param {FormatOptions} options - an optional layout engine, used for the reprint pass.
  * @returns {Promise<FormatResult>} Resolves successfully when the file has been formatted.
  */
-const formatFile = (filePath, configuration) => __awaiter(void 0, void 0, void 0, function* () {
+const formatFile = (filePath_1, configuration_1, ...args_1) => __awaiter(void 0, [filePath_1, configuration_1, ...args_1], void 0, function* (filePath, configuration, options = {}) {
     const config = configuration || (yield (0, getLintConfig_1.getLintConfig)());
     const diagnosticsBeforeFormat = yield (0, lint_1.lintFile)(filePath, config);
     const diagnosticsCountBeforeFormat = diagnosticsBeforeFormat.length;
     const text = yield (0, file_1.readFile)(filePath);
-    const formattedText = (0, shared_1.processText)(text, (0, parseLintOverride_1.applyLintOverride)(text, config));
+    const formattedText = yield (0, formatText_1.formatText)(text, config, options);
     yield (0, file_1.createFile)(filePath, formattedText);
     const diagnosticsAfterFormat = yield (0, lint_1.lintFile)(filePath, config);
     const diagnosticsCountAfterFormat = diagnosticsAfterFormat.length;

package/format/formatFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatFile.js","sourceRoot":"","sources":["../../src/format/formatFile.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAwD;AACxD,kCAAkC;AAGlC,kEAA8D;AAC9D,0DAAsD;AACtD,qCAAsC;AAEtC;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CACxB,QAAgB,EAChB,aAA0B,EACH,EAAE;IACzB,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,6BAAa,GAAE,CAAC,CAAA;IACvD,MAAM,uBAAuB,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAChE,MAAM,4BAA4B,GAAG,uBAAuB,CAAC,MAAM,CAAA;IAEnE,MAAM,IAAI,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,CAAC,CAAA;IAErC,MAAM,aAAa,GAAG,IAAA,oBAAW,EAAC,IAAI,EAAE,IAAA,qCAAiB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;IAExE,MAAM,IAAA,iBAAU,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAEzC,MAAM,sBAAsB,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC/D,MAAM,2BAA2B,GAAG,sBAAsB,CAAC,MAAM,CAAA;IAEjE,MAAM,qBAAqB,GACzB,4BAA4B,GAAG,2BAA2B,CAAA;IAE5D,MAAM,gBAAgB,GAAa,EAAE,CAAA;IAErC,IAAI,qBAAqB,EAAE,CAAC;QAC1B,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,OAAO;QACL,gBAAgB;QAChB,qBAAqB;QACrB,kBAAkB,EAAE,sBAAsB;KAC3C,CAAA;AACH,CAAC,CAAA,CAAA;AA/BY,QAAA,UAAU,cA+BtB"}
+{"version":3,"file":"formatFile.js","sourceRoot":"","sources":["../../src/format/formatFile.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAwD;AACxD,kCAAkC;AAGlC,0DAAsD;AAEtD,6CAAyC;AAEzC;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,yCAID,EAAE,gFAHzB,QAAgB,EAChB,aAA0B,EAC1B,UAAyB,EAAE;IAE3B,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,6BAAa,GAAE,CAAC,CAAA;IACvD,MAAM,uBAAuB,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAChE,MAAM,4BAA4B,GAAG,uBAAuB,CAAC,MAAM,CAAA;IAEnE,MAAM,IAAI,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,CAAC,CAAA;IAErC,MAAM,aAAa,GAAG,MAAM,IAAA,uBAAU,EAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7D,MAAM,IAAA,iBAAU,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAEzC,MAAM,sBAAsB,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC/D,MAAM,2BAA2B,GAAG,sBAAsB,CAAC,MAAM,CAAA;IAEjE,MAAM,qBAAqB,GACzB,4BAA4B,GAAG,2BAA2B,CAAA;IAE5D,MAAM,gBAAgB,GAAa,EAAE,CAAA;IAErC,IAAI,qBAAqB,EAAE,CAAC;QAC1B,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,OAAO;QACL,gBAAgB;QAChB,qBAAqB;QACrB,kBAAkB,EAAE,sBAAsB;KAC3C,CAAA;AACH,CAAC,CAAA,CAAA;AAhCY,QAAA,UAAU,cAgCtB"}

package/format/formatFolder.d.ts

@@ -1,9 +1,11 @@
 import { FormatResult } from '../types';
 import { LintConfig } from '../types/LintConfig';
+import { FormatOptions } from '../types/FormatOptions';
 /**
  * Automatically formats all SAS files in the folder at the given path.
  * @param {string} folderPath - the path to the folder to be formatted.
  * @param {LintConfig} configuration - an optional configuration. When not passed in, this is read from the .sasjslint file.
+ * @param {FormatOptions} options - an optional layout engine, passed to every file.
  * @returns {Promise<FormatResult>} Resolves successfully when all SAS files in the given folder have been formatted.
  */
-export declare const formatFolder: (folderPath: string, configuration?: LintConfig) => Promise<FormatResult>;
+export declare const formatFolder: (folderPath: string, configuration?: LintConfig, options?: FormatOptions) => Promise<FormatResult>;

package/format/formatFolder.js

@@ -20,6 +20,14 @@ const asyncForEach_1 = require("../utils/asyncForEach");
 const getLintConfig_1 = require("../utils/getLintConfig");
 const listSasFiles_1 = require("../utils/listSasFiles");
 const formatFile_1 = require("./formatFile");
+/**
+ * One line of the aggregate raised when a walk finishes with failures.
+ *
+ * The engine is the caller's own function, so what it throws is not necessarily an
+ * Error - a string is enough - and `error.message` on one of those reads
+ * `undefined`, dropping the reason the rejection was passed on for.
+ */
+const describeFailure = (where, error) => `${where}: ${error instanceof Error ? error.message : String(error)}`;
 const excludeFolders = [
     '.git',
     '.github',
@@ -32,32 +40,55 @@ const excludeFolders = [
  * Automatically formats all SAS files in the folder at the given path.
  * @param {string} folderPath - the path to the folder to be formatted.
  * @param {LintConfig} configuration - an optional configuration. When not passed in, this is read from the .sasjslint file.
+ * @param {FormatOptions} options - an optional layout engine, passed to every file.
  * @returns {Promise<FormatResult>} Resolves successfully when all SAS files in the given folder have been formatted.
  */
-const formatFolder = (folderPath, configuration) => __awaiter(void 0, void 0, void 0, function* () {
+const formatFolder = (folderPath_1, configuration_1, ...args_1) => __awaiter(void 0, [folderPath_1, configuration_1, ...args_1], void 0, function* (folderPath, configuration, options = {}) {
     const config = configuration || (yield (0, getLintConfig_1.getLintConfig)());
-    const diagnosticsBeforeFormat = yield (0, lint_1.lintFolder)(folderPath);
+    // The counts have to be measured with the same configuration the files are
+    // formatted by, or a rule the caller switched off is still counted as unfixed.
+    const diagnosticsBeforeFormat = yield (0, lint_1.lintFolder)(folderPath, config);
     const diagnosticsCountBeforeFormat = Array.from(diagnosticsBeforeFormat.values()).reduce((a, b) => a + b.length, 0);
     const fileNames = yield (0, listSasFiles_1.listSasFiles)(folderPath);
+    // A file the engine refuses must not decide what happens to the rest of the
+    // tree: the walk continues and the failures are raised together at the end, so
+    // one unformattable buffer cannot leave a project half written.
+    const failures = [];
     yield (0, asyncForEach_1.asyncForEach)(fileNames, (fileName) => __awaiter(void 0, void 0, void 0, function* () {
         const filePath = path_1.default.join(folderPath, fileName);
-        yield (0, formatFile_1.formatFile)(filePath);
+        try {
+            yield (0, formatFile_1.formatFile)(filePath, config, options);
+        }
+        catch (error) {
+            failures.push(describeFailure(filePath, error));
+        }
     }));
     const subFolders = (yield (0, file_1.listSubFoldersInFolder)(folderPath)).filter((f) => !excludeFolders.includes(f));
     yield (0, asyncForEach_1.asyncForEach)(subFolders, (subFolder) => __awaiter(void 0, void 0, void 0, function* () {
-        yield (0, exports.formatFolder)(path_1.default.join(folderPath, subFolder), config);
+        try {
+            yield (0, exports.formatFolder)(path_1.default.join(folderPath, subFolder), config, options);
+        }
+        catch (error) {
+            failures.push(describeFailure(path_1.default.join(folderPath, subFolder), error));
+        }
     }));
-    const diagnosticsAfterFormat = yield (0, lint_1.lintFolder)(folderPath);
+    const diagnosticsAfterFormat = yield (0, lint_1.lintFolder)(folderPath, config);
     const diagnosticsCountAfterFormat = Array.from(diagnosticsAfterFormat.values()).reduce((a, b) => a + b.length, 0);
     const fixedDiagnosticsCount = diagnosticsCountBeforeFormat - diagnosticsCountAfterFormat;
     const updatedFilePaths = [];
+    // Both maps come from lintFolder over the same file list, so every path in
+    // before is in after as well - a fallback there would be a branch no run reaches.
     Array.from(diagnosticsBeforeFormat.keys()).forEach((filePath) => {
-        const diagnosticsBefore = diagnosticsBeforeFormat.get(filePath) || [];
-        const diagnosticsAfter = diagnosticsAfterFormat.get(filePath) || [];
+        const diagnosticsBefore = diagnosticsBeforeFormat.get(filePath);
+        const diagnosticsAfter = diagnosticsAfterFormat.get(filePath);
         if (diagnosticsBefore.length !== diagnosticsAfter.length) {
             updatedFilePaths.push(filePath);
         }
     });
+    if (failures.length) {
+        throw new Error(`Could not format ${failures.length} file(s). Everything else was formatted.\n` +
+            failures.map((failure) => `  ${failure}`).join('\n'));
+    }
     return {
         updatedFilePaths,
         fixedDiagnosticsCount,

package/format/formatFolder.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatFolder.js","sourceRoot":"","sources":["../../src/format/formatFolder.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4CAA0D;AAC1D,gDAAuB;AACvB,kCAAoC;AAGpC,wDAAoD;AACpD,0DAAsD;AACtD,wDAAoD;AACpD,6CAAyC;AAEzC,MAAM,cAAc,GAAG;IACrB,MAAM;IACN,SAAS;IACT,SAAS;IACT,cAAc;IACd,YAAY;IACZ,cAAc;CACf,CAAA;AAED;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAC1B,UAAkB,EAClB,aAA0B,EACH,EAAE;IACzB,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,6BAAa,GAAE,CAAC,CAAA;IACvD,MAAM,uBAAuB,GAAG,MAAM,IAAA,iBAAU,EAAC,UAAU,CAAC,CAAA;IAC5D,MAAM,4BAA4B,GAAG,KAAK,CAAC,IAAI,CAC7C,uBAAuB,CAAC,MAAM,EAAE,CACjC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAEnC,MAAM,SAAS,GAAG,MAAM,IAAA,2BAAY,EAAC,UAAU,CAAC,CAAA;IAChD,MAAM,IAAA,2BAAY,EAAC,SAAS,EAAE,CAAO,QAAQ,EAAE,EAAE;QAC/C,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QAChD,MAAM,IAAA,uBAAU,EAAC,QAAQ,CAAC,CAAA;IAC5B,CAAC,CAAA,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,CAAC,MAAM,IAAA,6BAAsB,EAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAClE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAC3C,CAAA;IAED,MAAM,IAAA,2BAAY,EAAC,UAAU,EAAE,CAAO,SAAS,EAAE,EAAE;QACjD,MAAM,IAAA,oBAAY,EAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAA;IAC9D,CAAC,CAAA,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,MAAM,IAAA,iBAAU,EAAC,UAAU,CAAC,CAAA;IAC3D,MAAM,2BAA2B,GAAG,KAAK,CAAC,IAAI,CAC5C,sBAAsB,CAAC,MAAM,EAAE,CAChC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAEnC,MAAM,qBAAqB,GACzB,4BAA4B,GAAG,2BAA2B,CAAA;IAE5D,MAAM,gBAAgB,GAAa,EAAE,CAAA;IAErC,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC9D,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;QACrE,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;QAEnE,IAAI,iBAAiB,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EAAE,CAAC;YACzD,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACjC,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,gBAAgB;QAChB,qBAAqB;QACrB,kBAAkB,EAAE,sBAAsB;KAC3C,CAAA;AACH,CAAC,CAAA,CAAA;AAhDY,QAAA,YAAY,gBAgDxB"}
+{"version":3,"file":"formatFolder.js","sourceRoot":"","sources":["../../src/format/formatFolder.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4CAA0D;AAC1D,gDAAuB;AACvB,kCAAoC;AAGpC,wDAAoD;AACpD,0DAAsD;AACtD,wDAAoD;AAEpD,6CAAyC;AAEzC;;;;;;GAMG;AACH,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,KAAc,EAAE,EAAE,CACxD,GAAG,KAAK,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAA;AAEvE,MAAM,cAAc,GAAG;IACrB,MAAM;IACN,SAAS;IACT,SAAS;IACT,cAAc;IACd,YAAY;IACZ,cAAc;CACf,CAAA;AAED;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,2CAIH,EAAE,kFAHzB,UAAkB,EAClB,aAA0B,EAC1B,UAAyB,EAAE;IAE3B,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,6BAAa,GAAE,CAAC,CAAA;IACvD,2EAA2E;IAC3E,+EAA+E;IAC/E,MAAM,uBAAuB,GAAG,MAAM,IAAA,iBAAU,EAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IACpE,MAAM,4BAA4B,GAAG,KAAK,CAAC,IAAI,CAC7C,uBAAuB,CAAC,MAAM,EAAE,CACjC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAEnC,MAAM,SAAS,GAAG,MAAM,IAAA,2BAAY,EAAC,UAAU,CAAC,CAAA;IAChD,4EAA4E;IAC5E,+EAA+E;IAC/E,gEAAgE;IAChE,MAAM,QAAQ,GAAa,EAAE,CAAA;IAC7B,MAAM,IAAA,2BAAY,EAAC,SAAS,EAAE,CAAO,QAAQ,EAAE,EAAE;QAC/C,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QAChD,IAAI,CAAC;YACH,MAAM,IAAA,uBAAU,EAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC7C,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAA;QACjD,CAAC;IACH,CAAC,CAAA,CAAC,CAAA;IAEF,MAAM,UAAU,GAAG,CAAC,MAAM,IAAA,6BAAsB,EAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAClE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAC3C,CAAA;IAED,MAAM,IAAA,2BAAY,EAAC,UAAU,EAAE,CAAO,SAAS,EAAE,EAAE;QACjD,IAAI,CAAC;YACH,MAAM,IAAA,oBAAY,EAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACvE,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC,CAAA;QACzE,CAAC;IACH,CAAC,CAAA,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,MAAM,IAAA,iBAAU,EAAC,UAAU,EAAE,MAAM,CAAC,CAAA;IACnE,MAAM,2BAA2B,GAAG,KAAK,CAAC,IAAI,CAC5C,sBAAsB,CAAC,MAAM,EAAE,CAChC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAEnC,MAAM,qBAAqB,GACzB,4BAA4B,GAAG,2BAA2B,CAAA;IAE5D,MAAM,gBAAgB,GAAa,EAAE,CAAA;IAErC,2EAA2E;IAC3E,kFAAkF;IAClF,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC9D,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAA;QAChE,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAA;QAE9D,IAAI,iBAAiB,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EAAE,CAAC;YACzD,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACjC,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,CAAC,MAAM,4CAA4C;YAC7E,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACvD,CAAA;IACH,CAAC;IAED,OAAO;QACL,gBAAgB;QAChB,qBAAqB;QACrB,kBAAkB,EAAE,sBAAsB;KAC3C,CAAA;AACH,CAAC,CAAA,CAAA;AAxEY,QAAA,YAAY,gBAwExB"}

package/format/formatProject.d.ts

@@ -1,6 +1,7 @@
 import { FormatResult } from '../types/FormatResult';
+import { FormatOptions } from '../types/FormatOptions';
 /**
  * Automatically formats all SAS files in the current project.
  * @returns {Promise<FormatResult>} Resolves successfully when all SAS files in the current project have been formatted.
  */
-export declare const formatProject: () => Promise<FormatResult>;
+export declare const formatProject: (options?: FormatOptions) => Promise<FormatResult>;

package/format/formatProject.js

@@ -16,13 +16,13 @@ const formatFolder_1 = require("./formatFolder");
  * Automatically formats all SAS files in the current project.
  * @returns {Promise<FormatResult>} Resolves successfully when all SAS files in the current project have been formatted.
  */
-const formatProject = () => __awaiter(void 0, void 0, void 0, function* () {
+const formatProject = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (options = {}) {
     const projectRoot = (yield (0, getProjectRoot_1.getProjectRoot)()) || process.currentDir;
     if (!projectRoot) {
         throw new Error('SASjs Project Root was not found.');
     }
     console.info(`Formatting all .sas files under ${projectRoot}`);
-    return yield (0, formatFolder_1.formatFolder)(projectRoot);
+    return yield (0, formatFolder_1.formatFolder)(projectRoot, undefined, options);
 });
 exports.formatProject = formatProject;
 //# sourceMappingURL=formatProject.js.map

package/format/formatProject.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatProject.js","sourceRoot":"","sources":["../../src/format/formatProject.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,4DAAwD;AACxD,iDAA6C;AAE7C;;;GAGG;AACI,MAAM,aAAa,GAAG,GAAgC,EAAE;IAC7D,MAAM,WAAW,GAAG,CAAC,MAAM,IAAA,+BAAc,GAAE,CAAC,IAAI,OAAO,CAAC,UAAU,CAAA;IAClE,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IACtD,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,mCAAmC,WAAW,EAAE,CAAC,CAAA;IAE9D,OAAO,MAAM,IAAA,2BAAY,EAAC,WAAW,CAAC,CAAA;AACxC,CAAC,CAAA,CAAA;AATY,QAAA,aAAa,iBASzB"}
+{"version":3,"file":"formatProject.js","sourceRoot":"","sources":["../../src/format/formatProject.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,4DAAwD;AACxD,iDAA6C;AAE7C;;;GAGG;AACI,MAAM,aAAa,GAAG,YAEJ,EAAE,mDADzB,UAAyB,EAAE;IAE3B,MAAM,WAAW,GAAG,CAAC,MAAM,IAAA,+BAAc,GAAE,CAAC,IAAI,OAAO,CAAC,UAAU,CAAA;IAClE,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IACtD,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,mCAAmC,WAAW,EAAE,CAAC,CAAA;IAE9D,OAAO,MAAM,IAAA,2BAAY,EAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;AAC5D,CAAC,CAAA,CAAA;AAXY,QAAA,aAAa,iBAWzB"}

package/format/formatText.d.ts

@@ -1,2 +1,20 @@
+import { FormatOptions } from '../types/FormatOptions';
 import { LintConfig } from '../types';
-export declare const formatText: (text: string, configuration?: LintConfig) => Promise<string>;
+/**
+ * Formats SAS text: the caller's reprint pass if one was supplied, then the
+ * configured rules.
+ *
+ * The order is deliberate. A reprint decides where lines break and how blocks are
+ * indented, so the rules that wrap and trim have to run over its output - applying
+ * them to the original text and reprinting afterwards would undo both. The lint
+ * override comment travels with the text through the reprint (it is a comment),
+ * so `keywordCase` from an `@sasjslint` line applies to the same buffer.
+ *
+ * A rejection from the engine is not caught: its message is the one that says why
+ * (`@sasjs/sas-language` names the data file it could not read, for example), and
+ * a formatter that swallowed it would return a buffer that looks formatted and is
+ * not. `formatFolder` is the one place that catches, because there a single
+ * refusal must not stop the walk - it collects them and raises them together once
+ * the tree is done.
+ */
+export declare const formatText: (text: string, configuration?: LintConfig, options?: FormatOptions) => Promise<string>;

package/format/formatText.js

@@ -12,9 +12,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatText = void 0;
 const utils_1 = require("../utils");
 const shared_1 = require("./shared");
-const formatText = (text, configuration) => __awaiter(void 0, void 0, void 0, function* () {
-    const config = configuration || (yield (0, utils_1.getLintConfig)());
-    return (0, shared_1.processText)(text, (0, utils_1.applyLintOverride)(text, config));
+/**
+ * Formats SAS text: the caller's reprint pass if one was supplied, then the
+ * configured rules.
+ *
+ * The order is deliberate. A reprint decides where lines break and how blocks are
+ * indented, so the rules that wrap and trim have to run over its output - applying
+ * them to the original text and reprinting afterwards would undo both. The lint
+ * override comment travels with the text through the reprint (it is a comment),
+ * so `keywordCase` from an `@sasjslint` line applies to the same buffer.
+ *
+ * A rejection from the engine is not caught: its message is the one that says why
+ * (`@sasjs/sas-language` names the data file it could not read, for example), and
+ * a formatter that swallowed it would return a buffer that looks formatted and is
+ * not. `formatFolder` is the one place that catches, because there a single
+ * refusal must not stop the walk - it collects them and raises them together once
+ * the tree is done.
+ */
+const formatText = (text_1, configuration_1, ...args_1) => __awaiter(void 0, [text_1, configuration_1, ...args_1], void 0, function* (text, configuration, options = {}) {
+    const config = (0, utils_1.applyLintOverride)(text, configuration || (yield (0, utils_1.getLintConfig)()));
+    const formatted = options.reprint
+        ? yield options.reprint(text, { keywordCase: config.keywordCase })
+        : text;
+    return (0, shared_1.processText)(formatted, config);
 });
 exports.formatText = formatText;
 //# sourceMappingURL=formatText.js.map

package/format/formatText.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatText.js","sourceRoot":"","sources":["../../src/format/formatText.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,oCAA2D;AAC3D,qCAAsC;AAE/B,MAAM,UAAU,GAAG,CAAO,IAAY,EAAE,aAA0B,EAAE,EAAE;IAC3E,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,qBAAa,GAAE,CAAC,CAAA;IACvD,OAAO,IAAA,oBAAW,EAAC,IAAI,EAAE,IAAA,yBAAiB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;AAC3D,CAAC,CAAA,CAAA;AAHY,QAAA,UAAU,cAGtB"}
+{"version":3,"file":"formatText.js","sourceRoot":"","sources":["../../src/format/formatText.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,oCAA2D;AAC3D,qCAAsC;AAEtC;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,UAAU,GAAG,qCAIxB,EAAE,4EAHF,IAAY,EACZ,aAA0B,EAC1B,UAAyB,EAAE;IAE3B,MAAM,MAAM,GAAG,IAAA,yBAAiB,EAC9B,IAAI,EACJ,aAAa,IAAI,CAAC,MAAM,IAAA,qBAAa,GAAE,CAAC,CACzC,CAAA;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO;QAC/B,CAAC,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;QAClE,CAAC,CAAC,IAAI,CAAA;IAER,OAAO,IAAA,oBAAW,EAAC,SAAS,EAAE,MAAM,CAAC,CAAA;AACvC,CAAC,CAAA,CAAA;AAfY,QAAA,UAAU,cAetB"}

package/format/longLines.d.ts

@@ -0,0 +1,60 @@
+import { LintConfig } from '../types';
+/** A macro declaration, which the macro rules read as one statement. */
+export declare const macroDeclaration: RegExp;
+/**
+ * A macro comment statement - `%* text ;` - which is prose that happens to start
+ * with a trigger. Breaking it would put the terminator on a line of its own, and
+ * like a block comment it belongs to its author.
+ */
+export declare const macroComment: RegExp;
+/**
+ * A statement whose line breaks are data rather than space between tokens.
+ *
+ * For the DATA step's `put` and `putlog`, and the macro and window statements
+ * that write text a reader sees, a break adds a line to the log or to the file
+ * being written. For `%let` a break lands inside the value, and the value keeps
+ * the newline and the continuation indent - measured on a live engine, where a
+ * wrapped `%let` message compared against a single-spaced one failed.
+ *
+ * Both are broken with the `%trim(` idiom rather than by a plain newline, and
+ * neither is left as it is: a break that carries `%trim(` adds no whitespace and
+ * no output line.
+ */
+export declare const breakAwareStatement: RegExp;
+/**
+ * The index where the text of a `put`-family statement begins, so a break is
+ * never taken before the keyword that names it.
+ *
+ * A continuation line carries no keyword of its own, and its whole content is
+ * text, so there the text begins at the first non-whitespace character.
+ *
+ * @param {string} line - the line to read.
+ * @returns {number} the index of the first character of the statement's text.
+ */
+export declare const putTextStart: (line: string) => number;
+/** The index of the first non-whitespace character at or after `from`. */
+export declare const firstNonSpace: (line: string, from: number) => number;
+/**
+ * The indentation a continuation line takes: the next multiple of
+ * `indentationMultiple` after the line's own, so a break can never introduce an
+ * `indentationMultiple` diagnostic of its own.
+ */
+export declare const continuationIndentFor: (indent: string, multiple: number) => string;
+/** The indentation multiple in force, with the rule's documented default. */
+export declare const indentationMultipleOf: (configuration: LintConfig) => number;
+/**
+ * Reads whether one line opens, or carries the continuation of, a statement
+ * whose line breaks SAS reads as output lines.
+ *
+ * Splitting the code view on `;` gives one entry per statement on the line, the
+ * last entry being the part that has not reached its own terminator.
+ *
+ * @param {string} code - the line with literals and comments blanked.
+ * @param {boolean} open - whether the previous line left such a statement open.
+ * @returns {{ line: boolean, open: boolean }} whether this line belongs to one,
+ *   and whether the next line still does.
+ */
+export declare const breakAwareState: (code: string, open: boolean) => {
+    line: boolean;
+    open: boolean;
+};