Merge pull request #1250 from bryceosterhaus/LPD-55581

feat(eslint-plugin): add new rule for api submodule bundles

Author: bryceosterhaus

projects/eslint-plugin/configs/portal.js

@@ -10,6 +10,7 @@ const config = {
 	rules: {
 		'@liferay/portal/deprecation': 'error',
 		'@liferay/portal/empty-line-after-copyright': 'error',
+		'@liferay/portal/no-api-submodule-import': 'error',
 		'@liferay/portal/no-default-export-from-frontend-js-web': 'error',
 		'@liferay/portal/no-document-cookie': 'error',
 		'@liferay/portal/no-explicit-extend': 'error',

projects/eslint-plugin/rules/portal/index.js

@@ -6,6 +6,7 @@
 module.exports = {
 	'portal/deprecation': require('./lib/rules/deprecation'),
 	'portal/empty-line-after-copyright': require('./lib/rules/empty-line-after-copyright'),
+	'portal/no-api-submodule-import': require('./lib/rules/no-api-submodule-import'),
 	'portal/no-default-export-from-frontend-js-web': require('./lib/rules/no-default-export-from-frontend-js-web'),
 	'portal/no-document-cookie': require('./lib/rules/no-document-cookie'),
 	'portal/no-explicit-extend': require('./lib/rules/no-explicit-extend'),

projects/eslint-plugin/rules/portal/lib/rules/no-api-submodule-import.js

@@ -0,0 +1,60 @@
+/**
+ * SPDX-FileCopyrightText: © 2017 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: MIT
+ */
+
+const path = require('path');
+
+const DESCRIPTION =
+	'you cannot import files outside of the "/api" directory for your submodule.';
+
+const API_PATH = 'src/main/resources/META-INF/resources/js/api';
+
+function isPathEscapingAPIDir(filePath, relativePath) {
+	const resolvedTarget = path.resolve(path.dirname(filePath), relativePath);
+
+	return !resolvedTarget.includes(API_PATH);
+}
+
+function checkImportPath(node, context) {
+	if (
+		context.getFilename().includes(API_PATH) &&
+		node.source &&
+		node.source.type === 'Literal' &&
+		node.source.value.startsWith('.')
+	) {
+		if (isPathEscapingAPIDir(context.getFilename(), node.source.value)) {
+			context.report({
+				message: DESCRIPTION,
+				node,
+			});
+		}
+	}
+}
+
+module.exports = {
+	create(context) {
+		return {
+			ExportDefaultDeclaration(node) {
+				checkImportPath(node, context);
+			},
+			ExportNamedDeclaration(node) {
+				checkImportPath(node, context);
+			},
+			ImportDeclaration(node) {
+				checkImportPath(node, context);
+			},
+		};
+	},
+
+	meta: {
+		docs: {
+			category: 'Best Practices',
+			description: DESCRIPTION,
+			recommended: false,
+		},
+		fixable: null,
+		schema: [],
+		type: 'problem',
+	},
+};