@forge/lint 5.6.7 → 5.7.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @forge/lint
 
+## 5.7.0-next.1
+
+### Patch Changes
+
+- Updated dependencies [cd0e244]
+  - @forge/manifest@8.6.1-next.0
+  - @forge/cli-shared@6.5.5-next.0
+
+## 5.7.0-next.0
+
+### Minor Changes
+
+- 874e9a2: Add linter to ensure UI Kit Frame component has set the resource property correctly
+
 ## 5.6.7
 
 ### Patch Changes

package/out/lint/lint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../src/lint/lint.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,MAAM,IAAI,CAAC;AAIpB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAkB,MAAM,oBAAoB,CAAC;AAYxG,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,iBAAiB,WAAY,UAAU,eAAe,UAAU,EAAE,4BAAuB,IA+CrG,CAAC;AAEF,eAAO,MAAM,YAAY,gBAAiB,UAAU,EAAE,KAAG,YAQxD,CAAC;AAEF,eAAO,MAAM,eAAe,aAChB,MAAM,UACR,eAAe,oBACN,OAAO,GAAG,QAAQ,CAAC,aAAa,KAChD,QAAQ,SAAS,CAOnB,CAAC;AAEF,eAAO,MAAM,IAAI,gBACF,MAAM,EAAE,YACX,QAAQ,eACL,MAAM,UACX,UAAU,6BAhBR,MAAM,UACR,eAAe,oBACN,OAAO,GAAG,QAAQ,CAAC,aAAa,KAChD,QAAQ,SAAS,CAAC,YAeV,eAAe,EAAE,KAWzB,QAAQ,UAAU,EAAE,CAyCtB,CAAC;AAwBF,eAAO,MAAM,QAAQ,WACX,UAAU,WACV,eAAe,KACtB,QAAQ,UAAU,EAAE,CAGtB,CAAC"}
+{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../../src/lint/lint.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,MAAM,IAAI,CAAC;AAIpB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAkB,MAAM,oBAAoB,CAAC;AAaxG,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,iBAAiB,WAAY,UAAU,eAAe,UAAU,EAAE,4BAAuB,IA+CrG,CAAC;AAEF,eAAO,MAAM,YAAY,gBAAiB,UAAU,EAAE,KAAG,YAQxD,CAAC;AAEF,eAAO,MAAM,eAAe,aAChB,MAAM,UACR,eAAe,oBACN,OAAO,GAAG,QAAQ,CAAC,aAAa,KAChD,QAAQ,SAAS,CAOnB,CAAC;AAEF,eAAO,MAAM,IAAI,gBACF,MAAM,EAAE,YACX,QAAQ,eACL,MAAM,UACX,UAAU,6BAhBR,MAAM,UACR,eAAe,oBACN,OAAO,GAAG,QAAQ,CAAC,aAAa,KAChD,QAAQ,SAAS,CAAC,YAeV,eAAe,EAAE,KAYzB,QAAQ,UAAU,EAAE,CAyCtB,CAAC;AAwBF,eAAO,MAAM,QAAQ,WACX,UAAU,WACV,eAAe,KACtB,QAAQ,UAAU,EAAE,CAGtB,CAAC"}

package/out/lint/lint.js

@@ -17,6 +17,7 @@ const dynamic_properties_permissions_linter_1 = require("./linters/dynamic-prope
 const remote_compute_manifest_linter_1 = require("./linters/manifest-linter/remote-compute-manifest-linter");
 const invoke_remote_linter_1 = require("./linters/remote-linter/invoke-remote-linter");
 const storage_module_linter_1 = require("./linters/storage-module-linter/storage-module-linter");
+const frame_component_linter_1 = require("./linters/frame-component-linter/frame-component-linter");
 const reportLintResults = (logger, lintResults, showSummary = true) => {
     let numErrors = 0, numWarnings = 0;
     let noProblemsFound = true;
@@ -87,7 +88,8 @@ const lint = async (filesToLint, manifest, environment, logger, parseFunction =
     new handler_linter_1.HandlerLinter(environment, manifest, logger),
     new dynamic_properties_permissions_linter_1.DynamicPropertiesPermissionsLinter(environment, manifest, logger),
     new invoke_remote_linter_1.InvokeRemoteLinter(environment, manifest, logger),
-    new storage_module_linter_1.StorageModulesLinter(environment, manifest, logger)
+    new storage_module_linter_1.StorageModulesLinter(environment, manifest, logger),
+    new frame_component_linter_1.FrameComponentLinter(environment, manifest, logger)
 ]) => {
     const { include, exclude } = await (0, cli_shared_1.listTSConfigIncludeExclude)(new cli_shared_1.FileSystemReader());
     const tsInclude = new Set(include);

package/out/lint/linters/frame-component-linter/frame-component-interface.d.ts

@@ -0,0 +1,5 @@
+import { LintCriteriaMatch } from '../../linter-interface';
+export declare type FrameResourceInfo = LintCriteriaMatch & {
+    resource: string | undefined;
+};
+//# sourceMappingURL=frame-component-interface.d.ts.map

package/out/lint/linters/frame-component-linter/frame-component-interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frame-component-interface.d.ts","sourceRoot":"","sources":["../../../../src/lint/linters/frame-component-linter/frame-component-interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,oBAAY,iBAAiB,GAAG,iBAAiB,GAAG;IAClD,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC"}

package/out/lint/linters/frame-component-linter/frame-component-interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/out/lint/linters/frame-component-linter/frame-component-linter.d.ts

@@ -0,0 +1,17 @@
+import { ManifestSchema as Manifest } from '@forge/manifest';
+import BaseLinter from '../../base-linter';
+import { FrameResourceInfo } from './frame-component-interface';
+import { LintLogger } from '../../linter-interface';
+interface FrameComponentLintCriteriaMatches {
+    [key: string]: FrameResourceInfo[];
+    frameComponentResource: FrameResourceInfo[];
+}
+export declare class FrameComponentLinter extends BaseLinter<FrameResourceInfo, FrameComponentLintCriteriaMatches, FrameResourceInfo[]> {
+    private manifest;
+    constructor(environment: string, manifest: Manifest, logger: LintLogger);
+    bootstrap(): Promise<void>;
+    protected setupMatchesMap(filepath: string): void;
+    protected addLintCriteriaMatch(frameResourceInfo: FrameResourceInfo, filepath: string): void;
+}
+export {};
+//# sourceMappingURL=frame-component-linter.d.ts.map

package/out/lint/linters/frame-component-linter/frame-component-linter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frame-component-linter.d.ts","sourceRoot":"","sources":["../../../../src/lint/linters/frame-component-linter/frame-component-linter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE7D,OAAO,UAAU,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAGhE,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD,UAAU,iCAAiC;IACzC,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAAC;IACnC,sBAAsB,EAAE,iBAAiB,EAAE,CAAC;CAC7C;AAED,qBAAa,oBAAqB,SAAQ,UAAU,CAClD,iBAAiB,EACjB,iCAAiC,EACjC,iBAAiB,EAAE,CACpB;IAGG,OAAO,CAAC,QAAQ;gBADhB,WAAW,EAAE,MAAM,EACX,QAAQ,EAAE,QAAQ,EAC1B,MAAM,EAAE,UAAU;IAKP,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IASvC,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMjD,SAAS,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;CAK7F"}

package/out/lint/linters/frame-component-linter/frame-component-linter.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FrameComponentLinter = void 0;
+const tslib_1 = require("tslib");
+const cli_shared_1 = require("@forge/cli-shared");
+const base_linter_1 = tslib_1.__importDefault(require("../../base-linter"));
+const frame_component_verifier_1 = require("./verifiers/frame-component-verifier");
+const frame_component_visitor_1 = require("./visitors/frame-component-visitor");
+class FrameComponentLinter extends base_linter_1.default {
+    manifest;
+    constructor(environment, manifest, logger) {
+        super(environment, logger);
+        this.manifest = manifest;
+    }
+    async bootstrap() {
+        this.nodeVisitors = [new frame_component_visitor_1.FrameComponentVisitor()];
+        const humanReadableEnvironment = (0, cli_shared_1.environmentToOption)(this.environment);
+        this.verifiers = {
+            frameComponentResource: new frame_component_verifier_1.FrameComponentVerifier(humanReadableEnvironment, this.manifest)
+        };
+    }
+    setupMatchesMap(filepath) {
+        this.matches.set(filepath, {
+            frameComponentResource: []
+        });
+    }
+    addLintCriteriaMatch(frameResourceInfo, filepath) {
+        const criteriaMatches = this.matches.get(filepath);
+        criteriaMatches.frameComponentResource.push(frameResourceInfo);
+    }
+}
+exports.FrameComponentLinter = FrameComponentLinter;

package/out/lint/linters/frame-component-linter/verifiers/frame-component-verifier.d.ts

@@ -0,0 +1,13 @@
+import type { ManifestSchema as Manifest } from '@forge/manifest';
+import { LintClass, LintResultRule } from '../../../linter-interface';
+import { BaseLintIssueVerifier, LintIssueVerifier } from '../../verifier-interface';
+import { type FrameResourceInfo } from '../frame-component-interface';
+export declare class FrameComponentVerifier extends BaseLintIssueVerifier implements LintIssueVerifier<FrameResourceInfo[]> {
+    private possibleFrameResourceKeys;
+    constructor(environment: string, manifest: Manifest);
+    protected getLintClass(): LintClass;
+    process(frameResources: FrameResourceInfo[]): Promise<LintResultRule[]>;
+    private isValidFrameResourceKey;
+    private getPossibleFrameResourceKeysFromManifest;
+}
+//# sourceMappingURL=frame-component-verifier.d.ts.map

package/out/lint/linters/frame-component-linter/verifiers/frame-component-verifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frame-component-verifier.d.ts","sourceRoot":"","sources":["../../../../../src/lint/linters/frame-component-linter/verifiers/frame-component-verifier.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAEpF,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEtE,qBAAa,sBAAuB,SAAQ,qBAAsB,YAAW,iBAAiB,CAAC,iBAAiB,EAAE,CAAC;IACjH,OAAO,CAAC,yBAAyB,CAAc;gBAEnC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;IAKnD,SAAS,CAAC,YAAY,IAAI,SAAS;IAItB,OAAO,CAAC,cAAc,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAepF,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,wCAAwC;CAQjD"}

package/out/lint/linters/frame-component-linter/verifiers/frame-component-verifier.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FrameComponentVerifier = void 0;
+const linter_interface_1 = require("../../../linter-interface");
+const verifier_interface_1 = require("../../verifier-interface");
+const text_1 = require("../../../text");
+class FrameComponentVerifier extends verifier_interface_1.BaseLintIssueVerifier {
+    possibleFrameResourceKeys;
+    constructor(environment, manifest) {
+        super(environment, manifest);
+        this.possibleFrameResourceKeys = this.getPossibleFrameResourceKeysFromManifest();
+    }
+    getLintClass() {
+        return linter_interface_1.LintClass.Error;
+    }
+    async process(frameResources) {
+        return frameResources
+            .filter(({ resource }) => !this.isValidFrameResourceKey(resource))
+            .map(({ resource, column, line }) => {
+            const linterMessages = text_1.messages.verifiers.frameComponentResource;
+            return {
+                class: this.getLintClass(),
+                column,
+                line,
+                message: resource ? linterMessages.invalid.message(resource) : linterMessages.missing.message(),
+                reference: resource ? linterMessages.invalid.reference : linterMessages.missing.reference
+            };
+        });
+    }
+    isValidFrameResourceKey(resourceKey) {
+        if (!resourceKey) {
+            return false;
+        }
+        return this.possibleFrameResourceKeys.has(resourceKey);
+    }
+    getPossibleFrameResourceKeysFromManifest() {
+        const resources = this.manifest?.resources ?? [];
+        return new Set(resources.map(({ key }) => key));
+    }
+}
+exports.FrameComponentVerifier = FrameComponentVerifier;

package/out/lint/linters/frame-component-linter/visitors/frame-component-visitor.d.ts

@@ -0,0 +1,9 @@
+import { NodeVisitor } from '../../node-visitor-interface';
+import { type TSESTree } from '@typescript-eslint/typescript-estree';
+import { type FrameResourceInfo } from '../frame-component-interface';
+export declare class FrameComponentVisitor implements NodeVisitor<FrameResourceInfo> {
+    visit(node: TSESTree.Node, _parent: TSESTree.Node | undefined, callback: (frameResourceInfo: FrameResourceInfo) => void): void;
+    private getFrameComponentNode;
+    private getFrameComponentResourceInfo;
+}
+//# sourceMappingURL=frame-component-visitor.d.ts.map

package/out/lint/linters/frame-component-linter/visitors/frame-component-visitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frame-component-visitor.d.ts","sourceRoot":"","sources":["../../../../../src/lint/linters/frame-component-linter/visitors/frame-component-visitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAkB,KAAK,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AACrF,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AA6BtE,qBAAa,qBAAsB,YAAW,WAAW,CAAC,iBAAiB,CAAC;IACnE,KAAK,CACV,IAAI,EAAE,QAAQ,CAAC,IAAI,EACnB,OAAO,EAAE,QAAQ,CAAC,IAAI,GAAG,SAAS,EAClC,QAAQ,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,KAAK,IAAI,GACvD,IAAI;IAWP,OAAO,CAAC,qBAAqB;IAY7B,OAAO,CAAC,6BAA6B;CAmCtC"}

package/out/lint/linters/frame-component-linter/visitors/frame-component-visitor.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FrameComponentVisitor = void 0;
+const typescript_estree_1 = require("@typescript-eslint/typescript-estree");
+const ensureResourceKeyValue = (raw) => {
+    const value = raw?.trim() ?? '';
+    return value.length > 0 ? value : undefined;
+};
+const resolveStringAttributeValue = (node) => {
+    const value = node.value;
+    if (value && value.type === typescript_estree_1.AST_NODE_TYPES.Literal && typeof value.value === 'string') {
+        return ensureResourceKeyValue(value.value);
+    }
+    else if (value && value.type === typescript_estree_1.AST_NODE_TYPES.JSXExpressionContainer) {
+        const expression = value.expression;
+        if (expression.type === typescript_estree_1.AST_NODE_TYPES.Literal && typeof expression.value === 'string') {
+            return ensureResourceKeyValue(expression.value);
+        }
+        else if (expression.type === typescript_estree_1.AST_NODE_TYPES.TemplateLiteral) {
+            const { quasis } = expression;
+            if (quasis.length === 1) {
+                return ensureResourceKeyValue(quasis[0].value.raw);
+            }
+        }
+    }
+    return false;
+};
+class FrameComponentVisitor {
+    visit(node, _parent, callback) {
+        const frameComponentNode = this.getFrameComponentNode(node);
+        if (!frameComponentNode) {
+            return undefined;
+        }
+        const frameResourceInfo = this.getFrameComponentResourceInfo(frameComponentNode);
+        if (frameResourceInfo) {
+            callback(frameResourceInfo);
+        }
+    }
+    getFrameComponentNode(node) {
+        if (node.type !== typescript_estree_1.AST_NODE_TYPES.JSXOpeningElement) {
+            return undefined;
+        }
+        const { name: nameNode } = node;
+        if (nameNode.type === typescript_estree_1.AST_NODE_TYPES.JSXIdentifier && nameNode.name === 'Frame') {
+            return node;
+        }
+        return undefined;
+    }
+    getFrameComponentResourceInfo(node) {
+        const { attributes } = node;
+        const resourceNode = attributes.find((attribute) => {
+            return attribute.type === typescript_estree_1.AST_NODE_TYPES.JSXAttribute && attribute.name.name === 'resource';
+        });
+        if (!resourceNode) {
+            return {
+                resource: undefined,
+                line: node.loc.start.line,
+                column: node.loc.start.column
+            };
+        }
+        else if (resourceNode.type === typescript_estree_1.AST_NODE_TYPES.JSXAttribute) {
+            const resourceKey = resolveStringAttributeValue(resourceNode);
+            if (resourceKey !== false && resourceNode.value) {
+                const { loc: { start: { line, column } } } = resourceNode.value;
+                return {
+                    resource: resourceKey,
+                    line,
+                    column
+                };
+            }
+        }
+        return undefined;
+    }
+}
+exports.FrameComponentVisitor = FrameComponentVisitor;

package/out/lint/text/messages.d.ts

@@ -41,6 +41,16 @@ export declare const messages: {
             message: (module: string) => string;
             reference: string;
         };
+        frameComponentResource: {
+            missing: {
+                message: () => string;
+                reference: string;
+            };
+            invalid: {
+                message: (resource: string) => string;
+                reference: string;
+            };
+        };
     };
 };
 //# sourceMappingURL=messages.d.ts.map

package/out/lint/text/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/lint/text/messages.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ;;;2BAGA,MAAM;;;;2BAKN,MAAM;2BAER,MAAM;;;;2BAKJ,MAAM;;;;iCAKA,MAAM;;;;iCAKN,MAAM;;;;8BAKT,MAAM,OAAO,MAAM;;;;+BAKlB,MAAM,UAAU,MAAM,QAAQ,MAAM,GAAG,SAAS,SAAS,MAAM;;;;6BAKjE,MAAM;;;;+BAIJ,MAAM,QAAQ,MAAM,SAAS,MAAM;;;;8BAKpC,MAAM;;;;CAI7B,CAAC"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/lint/text/messages.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ;;;2BAGA,MAAM;;;;2BAKN,MAAM;2BAER,MAAM;;;;2BAKJ,MAAM;;;;iCAKA,MAAM;;;;iCAKN,MAAM;;;;8BAKT,MAAM,OAAO,MAAM;;;;+BAKlB,MAAM,UAAU,MAAM,QAAQ,MAAM,GAAG,SAAS,SAAS,MAAM;;;;6BAKjE,MAAM;;;;+BAIJ,MAAM,QAAQ,MAAM,SAAS,MAAM;;;;8BAKpC,MAAM;;;;;;;;;oCASF,MAAM;;;;;CAOjC,CAAC"}

package/out/lint/text/messages.js

@@ -43,6 +43,18 @@ exports.messages = {
         sql: {
             message: (module) => `SQL package is used but '${module}' module is not defined in the manifest`,
             reference: 'https://developer.atlassian.com/platform/forge/manifest-reference/#modules'
+        },
+        frameComponentResource: {
+            missing: {
+                message: () => 'The "resource" property is missing in the Frame component',
+                reference: 'missing-frame-component-resource-property'
+            },
+            invalid: {
+                message: (resource) => {
+                    return `The resource attribute "${resource}" is not included in the "resources" section of your app's manifest.yml file`;
+                },
+                reference: 'valid-frame-component-resource-attribute-required'
+            }
         }
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/lint",
-  "version": "5.6.7",
+  "version": "5.7.0-next.1",
   "description": "Linting for forge apps",
   "main": "out/index.js",
   "license": "UNLICENSED",
@@ -19,9 +19,9 @@
     "eslint-plugin-import": "^2.29.1"
   },
   "dependencies": {
-    "@forge/cli-shared": "6.5.4",
+    "@forge/cli-shared": "6.5.5-next.0",
     "@forge/egress": "1.3.0",
-    "@forge/manifest": "8.6.0",
+    "@forge/manifest": "8.6.1-next.0",
     "@typescript-eslint/typescript-estree": "^5.62.0",
     "array.prototype.flatmap": "^1.3.2",
     "atlassian-openapi": "^1.0.18",