@lightdash/cli 2.416.0 → 2.418.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"projectResources.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/projectResources.ts"],"names":[],"mappings":"AAAA,OAAO,EAKH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEzD,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,cAAc,CAkBzE,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,sBAAsB,CAAC,iBAAiB,CAwB5E,CAAC;AAEN,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,WAAW,CAyBtE,CAAC;AAEF,eAAO,MAAM,iCAAiC,EAAE,sBAAsB,CAAC,wBAAwB,CAwB1F,CAAC;AA4CN,eAAO,MAAM,gCAAgC,iDAKvC,CAAC;AAEP,eAAO,MAAM,mBAAmB,qCAI9B,CAAC;AAEH,eAAO,MAAM,2BAA2B,gDAKlC,CAAC;AAEP,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,cAAc,CAiBzE,CAAC"}
1
+ {"version":3,"file":"projectResources.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/projectResources.ts"],"names":[],"mappings":"AAAA,OAAO,EAKH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEzD,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,cAAc,CAkBzE,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,sBAAsB,CAAC,iBAAiB,CAwB5E,CAAC;AAEN,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,WAAW,CAyBtE,CAAC;AAEF,eAAO,MAAM,iCAAiC,EAAE,sBAAsB,CAAC,wBAAwB,CAwB1F,CAAC;AA4CN,eAAO,MAAM,gCAAgC,iDAKvC,CAAC;AAEP,eAAO,MAAM,mBAAmB,qCAI9B,CAAC;AAEH,eAAO,MAAM,2BAA2B,gDAKlC,CAAC;AAEP,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,cAAc,CA0BzE,CAAC"}
@@ -152,4 +152,13 @@ exports.DOCUMENT_CODE_RESOURCE = {
152
152
  displayName: ({ name }) => name,
153
153
  parse: (input) => (0, common_1.parseDocumentAsCode)(input),
154
154
  sort: (left, right) => left.slug.localeCompare(right.slug),
155
+ leadingKeys: [
156
+ 'name',
157
+ 'slug',
158
+ 'description',
159
+ 'spaceSlug',
160
+ 'schemaVersion',
161
+ 'markdown',
162
+ 'charts',
163
+ ],
155
164
  };
@@ -22,6 +22,8 @@ export type CodeResourceDefinition<Document> = {
22
22
  parse: (value: unknown, source: string) => Document;
23
23
  serialize?: (document: Document) => unknown;
24
24
  sort?: (left: Document, right: Document) => number;
25
+ /** Keys written first, in this order; the rest stay alphabetical. */
26
+ leadingKeys?: readonly string[];
25
27
  };
26
28
  export type CodeFileFailure = {
27
29
  message: string;
@@ -1 +1 @@
1
- {"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/resource.ts"],"names":[],"mappings":"AACA,OAAO,EAGH,cAAc,EAEd,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EACjC,MAAM,mBAAmB,CAAC;AAM3B,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,cAAc,CAAC;AAE3D,MAAM,MAAM,sBAAsB,CAAC,QAAQ,IAAI;IAC3C,IAAI,EAAE,yBAAyB,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,iBAAiB,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,QAAQ,EAAE;QACN,QAAQ,EACF,uBAAuB,GACvB,UAAU,GACV,oBAAoB,GACpB,OAAO,GACP,mBAAmB,CAAC;QAC1B,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,CAAC,EAAE,OAAO,CAAC;KAC5B,CAAC;IACF,YAAY,EAAE,SAAS,yBAAyB,EAAE,CAAC;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAC;IACzC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;IACjD,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAC;IAC5C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;IACtC,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,QAAQ,CAAC;IACpD,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC;IAC5C,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,KAAK,MAAM,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,QAAQ,IAAI;IACtC,KAAK,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC,CAAC;IACvD,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,qBAAa,sBAAuB,SAAQ,cAAc;IACtD,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;IAE7C,YAAY,QAAQ,EAAE,yBAAyB,EAAE,OAAO,EAAE,MAAM,EAI/D;CACJ;AAED,eAAO,MAAM,wBAAwB,UAC1B,OAAO,KACf,KAAK,IAAI,sBAAiE,CAAC;AAgB9E,eAAO,MAAM,qBAAqB,GAAU,QAAQ,6BAGjD;IACC,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;CACpB,KAAG,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CA8DtC,CAAC;AAEF,eAAO,MAAM,0BAA0B,GAAU,QAAQ,6DAKtD;IACC,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,mBAAmB,EAAE,OAAO,CAAC;CAChC,KAAG,OAAO,CAAC,IAAI,CA6Ef,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAU,QAAQ,mCAIhD;IACC,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;CACnC,KAAG,OAAO,CAAC,MAAM,CASjB,CAAC;AAoBF,eAAO,MAAM,kBAAkB,GAAU,QAAQ,gDAK9C;IACC,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACnE,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;CAC3C,KAAG,OAAO,CAAC,yBAAyB,CA2BpC,CAAC;AAEF,eAAO,MAAM,4BAA4B,GAAI,QAAQ,UACzC,iBAAiB,CAAC,QAAQ,CAAC,KACpC,IAMF,CAAC"}
1
+ {"version":3,"file":"resource.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/resource.ts"],"names":[],"mappings":"AACA,OAAO,EAGH,cAAc,EAEd,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EACjC,MAAM,mBAAmB,CAAC;AAM3B,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,cAAc,CAAC;AAE3D,MAAM,MAAM,sBAAsB,CAAC,QAAQ,IAAI;IAC3C,IAAI,EAAE,yBAAyB,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,iBAAiB,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,QAAQ,EAAE;QACN,QAAQ,EACF,uBAAuB,GACvB,UAAU,GACV,oBAAoB,GACpB,OAAO,GACP,mBAAmB,CAAC;QAC1B,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,CAAC,EAAE,OAAO,CAAC;KAC5B,CAAC;IACF,YAAY,EAAE,SAAS,yBAAyB,EAAE,CAAC;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAC;IACzC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;IACjD,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,MAAM,CAAC;IAC5C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;IACtC,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,QAAQ,CAAC;IACpD,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC;IAC5C,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,KAAK,MAAM,CAAC;IACnD,qEAAqE;IACrE,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC,CAAC;AAeF,MAAM,MAAM,eAAe,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,QAAQ,IAAI;IACtC,KAAK,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC,CAAC;IACvD,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,qBAAa,sBAAuB,SAAQ,cAAc;IACtD,QAAQ,CAAC,QAAQ,EAAE,yBAAyB,CAAC;IAE7C,YAAY,QAAQ,EAAE,yBAAyB,EAAE,OAAO,EAAE,MAAM,EAI/D;CACJ;AAED,eAAO,MAAM,wBAAwB,UAC1B,OAAO,KACf,KAAK,IAAI,sBAAiE,CAAC;AAgB9E,eAAO,MAAM,qBAAqB,GAAU,QAAQ,6BAGjD;IACC,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;CACpB,KAAG,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CA8DtC,CAAC;AAEF,eAAO,MAAM,0BAA0B,GAAU,QAAQ,6DAKtD;IACC,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,mBAAmB,EAAE,OAAO,CAAC;CAChC,KAAG,OAAO,CAAC,IAAI,CA+Ef,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAU,QAAQ,mCAIhD;IACC,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;CACnC,KAAG,OAAO,CAAC,MAAM,CASjB,CAAC;AAoBF,eAAO,MAAM,kBAAkB,GAAU,QAAQ,gDAK9C;IACC,UAAU,EAAE,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACnE,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;CAC3C,KAAG,OAAO,CAAC,yBAAyB,CA2BpC,CAAC;AAEF,eAAO,MAAM,4BAA4B,GAAI,QAAQ,UACzC,iBAAiB,CAAC,QAAQ,CAAC,KACpC,IAMF,CAAC"}
@@ -8,6 +8,18 @@ const fs_1 = require("fs");
8
8
  const yaml = tslib_1.__importStar(require("js-yaml"));
9
9
  const path = tslib_1.__importStar(require("path"));
10
10
  const fileNames_1 = require("./fileNames");
11
+ const getKeyComparator = (leadingKeys) => (left, right) => {
12
+ const leftRank = leadingKeys.indexOf(left);
13
+ const rightRank = leadingKeys.indexOf(right);
14
+ if (leftRank !== -1 || rightRank !== -1) {
15
+ if (leftRank === -1)
16
+ return 1;
17
+ if (rightRank === -1)
18
+ return -1;
19
+ return leftRank - rightRank;
20
+ }
21
+ return left.localeCompare(right);
22
+ };
11
23
  class CodeResourcePhaseError extends common_1.ParameterError {
12
24
  resource;
13
25
  constructor(resource, message) {
@@ -113,7 +125,9 @@ const writeCodeResourceDocuments = async ({ definition, basePath, documents, pru
113
125
  });
114
126
  await Promise.all(sortedDocuments.map((document, index) => fs_1.promises.writeFile(path.join(folder, fileNames[index]), yaml.dump(definition.serialize?.(document) ?? document, {
115
127
  quotingType: '"',
116
- sortKeys: true,
128
+ sortKeys: definition.leadingKeys
129
+ ? getKeyComparator(definition.leadingKeys)
130
+ : true,
117
131
  }))));
118
132
  if (pruneOtherDocuments) {
119
133
  const downloadedIdentities = new Set(sortedDocuments.map((document) => normalizeIdentity(definition, definition.identity(document))));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lightdash/cli",
3
- "version": "2.416.0",
3
+ "version": "2.418.0",
4
4
  "description": "Lightdash CLI tool",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -22,8 +22,8 @@
22
22
  "@actions/core": "1.11.1",
23
23
  "@aws-sdk/credential-providers": "3.995.0",
24
24
  "@casl/ability": "6.8.0",
25
- "@lightdash/common": "2.416.0",
26
- "@lightdash/warehouses": "2.416.0",
25
+ "@lightdash/common": "2.418.0",
26
+ "@lightdash/warehouses": "2.418.0",
27
27
  "@sidvind/better-ajv-errors": "7.0.0",
28
28
  "@types/columnify": "1.5.1",
29
29
  "ajv": "8.18.0",