@forge/lint 5.5.2-next.9 → 5.6.0-next.12

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @forge/lint
 
+## 5.6.0-next.12
+
+### Patch Changes
+
+- Updated dependencies [8ca9a19]
+  - @forge/manifest@8.0.0-next.9
+  - @forge/cli-shared@6.3.0-next.11
+
+## 5.6.0-next.11
+
+### Minor Changes
+
+- 3e59d28: Validate sql module during linting
+
+## 5.5.2-next.10
+
+### Patch Changes
+
+- Updated dependencies [34bd8b6]
+  - @forge/cli-shared@6.3.0-next.10
+
 ## 5.5.2-next.9
 
 ### 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;AAWxG,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,KAUzB,QAAQ,UAAU,EAAE,CAyCtB,CAAC;AAEF,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;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;AAEF,eAAO,MAAM,QAAQ,WACX,UAAU,WACV,eAAe,KACtB,QAAQ,UAAU,EAAE,CAGtB,CAAC"}

package/out/lint/lint.js

@@ -16,6 +16,7 @@ const deprecated_csp_permissions_manifest_linter_1 = require("./linters/manifest
 const dynamic_properties_permissions_linter_1 = require("./linters/dynamic-properties-linter/dynamic-properties-permissions-linter");
 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 reportLintResults = (logger, lintResults, showSummary = true) => {
     let numErrors = 0, numWarnings = 0;
     let noProblemsFound = true;
@@ -85,7 +86,8 @@ const lint = async (filesToLint, manifest, environment, logger, parseFunction =
     new full_manifest_linter_1.FullManifestLinter(logger),
     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 invoke_remote_linter_1.InvokeRemoteLinter(environment, manifest, logger),
+    new storage_module_linter_1.StorageModulesLinter(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/storage-module-linter/api-call-interface.d.ts

@@ -0,0 +1,10 @@
+import { LintCriteriaMatch } from '../../linter-interface';
+export declare enum ApiCallTypes {
+    'SQL' = 0
+}
+export declare type ProductName = 'jira' | 'confluence' | 'bitbucket';
+export interface SqlCall extends LintCriteriaMatch {
+    type: ApiCallTypes.SQL;
+}
+export declare type ApiCall = SqlCall;
+//# sourceMappingURL=api-call-interface.d.ts.map

package/out/lint/linters/storage-module-linter/api-call-interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-call-interface.d.ts","sourceRoot":"","sources":["../../../../src/lint/linters/storage-module-linter/api-call-interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,oBAAY,YAAY;IACtB,KAAK,IAAA;CACN;AAED,oBAAY,WAAW,GAAG,MAAM,GAAG,YAAY,GAAG,WAAW,CAAC;AAE9D,MAAM,WAAW,OAAQ,SAAQ,iBAAiB;IAChD,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC;CACxB;AAED,oBAAY,OAAO,GAAG,OAAO,CAAC"}

package/out/lint/linters/storage-module-linter/api-call-interface.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiCallTypes = void 0;
+var ApiCallTypes;
+(function (ApiCallTypes) {
+    ApiCallTypes[ApiCallTypes["SQL"] = 0] = "SQL";
+})(ApiCallTypes = exports.ApiCallTypes || (exports.ApiCallTypes = {}));

package/out/lint/linters/storage-module-linter/storage-module-linter.d.ts

@@ -0,0 +1,19 @@
+import { ManifestSchema as Manifest } from '@forge/manifest';
+import BaseLinter from '../../base-linter';
+import { LintFixState, LintLogger, LintResultRule } from '../../linter-interface';
+import { ApiCall, SqlCall } from './api-call-interface';
+interface StorageModuleLintCriteriaMatches {
+    [key: string]: ApiCall[];
+    sql: SqlCall[];
+}
+export declare const fixMissingModules: (errors: LintResultRule[], warnings: LintResultRule[], state: LintFixState) => Promise<LintFixState>;
+export declare class StorageModulesLinter extends BaseLinter<ApiCall, StorageModuleLintCriteriaMatches, ApiCall[]> {
+    private manifest;
+    constructor(environment: string, manifest: Manifest, logger: LintLogger);
+    bootstrap(): Promise<void>;
+    protected setupMatchesMap(filepath: string): void;
+    protected getFixer(): ((errors: LintResultRule[], warnings: LintResultRule[], state: LintFixState) => Promise<LintFixState>) | undefined;
+    protected addLintCriteriaMatch(apiCall: ApiCall, filepath: string): void;
+}
+export {};
+//# sourceMappingURL=storage-module-linter.d.ts.map

package/out/lint/linters/storage-module-linter/storage-module-linter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-module-linter.d.ts","sourceRoot":"","sources":["../../../../src/lint/linters/storage-module-linter/storage-module-linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,QAAQ,EAAW,MAAM,iBAAiB,CAAC;AACtE,OAAO,UAAU,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAE,OAAO,EAAgB,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAItE,UAAU,gCAAgC;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,EAAE,CAAC;IACzB,GAAG,EAAE,OAAO,EAAE,CAAC;CAChB;AAMD,eAAO,MAAM,iBAAiB,WACpB,cAAc,EAAE,YACd,cAAc,EAAE,SACnB,YAAY,KAClB,QAAQ,YAAY,CAoBtB,CAAC;AACF,qBAAa,oBAAqB,SAAQ,UAAU,CAAC,OAAO,EAAE,gCAAgC,EAAE,OAAO,EAAE,CAAC;IAGtG,OAAO,CAAC,QAAQ;gBADhB,WAAW,EAAE,MAAM,EACX,QAAQ,EAAE,QAAQ,EAC1B,MAAM,EAAE,UAAU;IAKP,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAQvC,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMjD,SAAS,CAAC,QAAQ,IACd,CAAC,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,YAAY,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC,GACtG,SAAS;IAIb,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;CAOzE"}

package/out/lint/linters/storage-module-linter/storage-module-linter.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageModulesLinter = exports.fixMissingModules = void 0;
+const tslib_1 = require("tslib");
+const base_linter_1 = tslib_1.__importDefault(require("../../base-linter"));
+const api_call_interface_1 = require("./api-call-interface");
+const sql_node_visitor_1 = require("./visitors/sql-node-visitor");
+const sql_verifier_1 = require("./verifiers/sql-verifier");
+var SqlEngine;
+(function (SqlEngine) {
+    SqlEngine["mysql"] = "mysql";
+})(SqlEngine || (SqlEngine = {}));
+const fixMissingModules = async (errors, warnings, state) => {
+    const currentModules = (await state.configFile.readConfig())?.modules ?? {};
+    if (warnings.length && !currentModules.sql) {
+        const newModules = {
+            ...currentModules,
+            sql: [
+                {
+                    key: 'db',
+                    engine: SqlEngine.mysql
+                }
+            ]
+        };
+        await state.configFile.writeToConfigFile('modules', newModules);
+        state.warningsFixed++;
+    }
+    return state;
+};
+exports.fixMissingModules = fixMissingModules;
+class StorageModulesLinter extends base_linter_1.default {
+    manifest;
+    constructor(environment, manifest, logger) {
+        super(environment, logger);
+        this.manifest = manifest;
+    }
+    async bootstrap() {
+        this.nodeVisitors = [new sql_node_visitor_1.SQLNodeVisitor()];
+        this.verifiers = {
+            sql: new sql_verifier_1.SQLVerifier(this.environment, this.manifest)
+        };
+    }
+    setupMatchesMap(filepath) {
+        this.matches.set(filepath, {
+            sql: []
+        });
+    }
+    getFixer() {
+        return exports.fixMissingModules;
+    }
+    addLintCriteriaMatch(apiCall, filepath) {
+        const criteriaMatches = this.matches.get(filepath);
+        if (apiCall.type === api_call_interface_1.ApiCallTypes.SQL) {
+            criteriaMatches.sql.push(apiCall);
+        }
+    }
+}
+exports.StorageModulesLinter = StorageModulesLinter;

package/out/lint/linters/storage-module-linter/verifiers/sql-verifier.d.ts

@@ -0,0 +1,8 @@
+import { LintResultRule, LintClass } from '../../../linter-interface';
+import { ApiCall } from '../api-call-interface';
+import { LintIssueVerifier, BaseLintIssueVerifier } from '../../verifier-interface';
+export declare class SQLVerifier extends BaseLintIssueVerifier implements LintIssueVerifier<ApiCall[]> {
+    protected getLintClass(): LintClass;
+    process(apiCalls: ApiCall[]): Promise<LintResultRule[]>;
+}
+//# sourceMappingURL=sql-verifier.d.ts.map

package/out/lint/linters/storage-module-linter/verifiers/sql-verifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-verifier.d.ts","sourceRoot":"","sources":["../../../../../src/lint/linters/storage-module-linter/verifiers/sql-verifier.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAKpF,qBAAa,WAAY,SAAQ,qBAAsB,YAAW,iBAAiB,CAAC,OAAO,EAAE,CAAC;IAC5F,SAAS,CAAC,YAAY,IAAI,SAAS;IAItB,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;CAerE"}

package/out/lint/linters/storage-module-linter/verifiers/sql-verifier.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQLVerifier = void 0;
+const linter_interface_1 = require("../../../linter-interface");
+const verifier_interface_1 = require("../../verifier-interface");
+const text_1 = require("../../../text");
+const SQL_MODULE = 'sql';
+class SQLVerifier extends verifier_interface_1.BaseLintIssueVerifier {
+    getLintClass() {
+        return linter_interface_1.LintClass.Warning;
+    }
+    async process(apiCalls) {
+        if (this.manifest.modules && SQL_MODULE in this.manifest.modules) {
+            return [];
+        }
+        return apiCalls.map((apiCall) => ({
+            class: this.getLintClass(),
+            message: text_1.messages.verifiers.sql.message(SQL_MODULE),
+            reference: text_1.messages.verifiers.sql.reference,
+            ...apiCall,
+            metadata: {
+                missingSQLModule: SQL_MODULE
+            }
+        }));
+    }
+}
+exports.SQLVerifier = SQLVerifier;

package/out/lint/linters/storage-module-linter/visitors/sql-node-visitor.d.ts

@@ -0,0 +1,10 @@
+import { TSESTree } from '@typescript-eslint/typescript-estree';
+import { NodeVisitor } from '../../node-visitor-interface';
+import { ApiCall, ApiCallTypes } from '../api-call-interface';
+export interface SQLApiCall extends ApiCall {
+    type: ApiCallTypes.SQL;
+}
+export declare class SQLNodeVisitor implements NodeVisitor<ApiCall> {
+    visit(node: TSESTree.Node, _parent: TSESTree.Node | undefined, callback: (apiCall: ApiCall) => void): void;
+}
+//# sourceMappingURL=sql-node-visitor.d.ts.map

package/out/lint/linters/storage-module-linter/visitors/sql-node-visitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-node-visitor.d.ts","sourceRoot":"","sources":["../../../../../src/lint/linters/storage-module-linter/visitors/sql-node-visitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE9D,MAAM,WAAW,UAAW,SAAQ,OAAO;IACzC,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC;CACxB;AAED,qBAAa,cAAe,YAAW,WAAW,CAAC,OAAO,CAAC;IAClD,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,GAAG,SAAS,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI;CAelH"}

package/out/lint/linters/storage-module-linter/visitors/sql-node-visitor.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQLNodeVisitor = void 0;
+const typescript_estree_1 = require("@typescript-eslint/typescript-estree");
+const api_call_interface_1 = require("../api-call-interface");
+class SQLNodeVisitor {
+    visit(node, _parent, callback) {
+        if (node.type === typescript_estree_1.AST_NODE_TYPES.ImportDeclaration && node.source.value === '@forge/sql') {
+            node.specifiers.forEach((specifier) => {
+                if (specifier.type === 'ImportDefaultSpecifier' && specifier.local.type === 'Identifier') {
+                    if (specifier.loc) {
+                        const sqlApiCall = {
+                            type: api_call_interface_1.ApiCallTypes.SQL,
+                            ...specifier.loc.start
+                        };
+                        callback(sqlApiCall);
+                    }
+                }
+            });
+        }
+    }
+}
+exports.SQLNodeVisitor = SQLNodeVisitor;

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

@@ -37,6 +37,10 @@ export declare const messages: {
             message: (product: string, hook: string, scope: string) => string;
             reference: string;
         };
+        sql: {
+            message: (module: 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;;;;CAK3D,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;;;;CAI7B,CAAC"}

package/out/lint/text/messages.js

@@ -39,6 +39,10 @@ exports.messages = {
         uiHook: {
             message: (product, hook, scope) => `${product} UI hook: "${hook}" requires the "${scope}" scope`,
             reference: 'permission-scope-required'
+        },
+        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'
         }
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/lint",
-  "version": "5.5.2-next.9",
+  "version": "5.6.0-next.12",
   "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.2.1-next.9",
+    "@forge/cli-shared": "6.3.0-next.11",
     "@forge/egress": "1.2.13",
-    "@forge/manifest": "8.0.0-next.8",
+    "@forge/manifest": "8.0.0-next.9",
     "@typescript-eslint/typescript-estree": "^5.62.0",
     "array.prototype.flatmap": "^1.3.2",
     "atlassian-openapi": "^1.0.18",