@spotinst/spinnaker-deck/packages/eslint-plugin/rules/import-from-npm-not-relative.js

Spinnaker-Deck service, forked with support to Spotinst

'use strict';
const { getSourceFileDetails, getRelativeImport } = require('../utils/import-aliases');

/**
 * A group of rules that enforce spinnaker ES6 import alias conventions.
 *
 * Source code in a package (i.e., `amazon`) should not import from package (i.e., `core`) using a relative path.
 * Instead, it should import from `@spinnaker/core`
 *
 * @version 0.1.0
 * @category conventions
 */
const rule = function(context) {
  const sourceFile = context.getFilename();
  const { modulesPath, sourceDirectory, ownPackage } = getSourceFileDetails(sourceFile);
  if (!ownPackage) {
    return {};
  }

  return {
    ImportDeclaration: function(node) {
      if (node.source.type !== 'Literal' || !node.source.value) {
        return;
      }

      const importString = node.source.value;
      const relativeImport = getRelativeImport(sourceDirectory, modulesPath, importString);

      if (!relativeImport || relativeImport.pkg === ownPackage) {
        return;
      }

      const { pkg } = relativeImport;
      const message =
        `Do not use a relative import to import from ${pkg} from code inside ${ownPackage}.` +
        ` Instead, use the npm package @spinnaker/${pkg}`;

      const fix = fixer => fixer.replaceText(node.source, `'@spinnaker/${pkg}'`);
      context.report({ fix, node, message });
    },
  };
};

module.exports = {
  meta: {
    type: 'problem',
    docs: {
      description: `Enforces spinnaker ES6 import conventions for package aliases`,
    },
    fixable: 'code',
  },
  create: rule,
};