eslint-plugin-n
Version:
Additional ESLint's rules for Node.js
71 lines (66 loc) • 2.61 kB
JavaScript
/**
* @author Toru Nagashima
* See LICENSE file in root directory for full license.
*/
const { checkPublish, messages } = require("../util/check-publish")
const getAllowModules = require("../util/get-allow-modules")
const getConvertPath = require("../util/get-convert-path")
const getResolvePaths = require("../util/get-resolve-paths")
const getResolverConfig = require("../util/get-resolver-config")
const getTryExtensions = require("../util/get-try-extensions")
const visitImport = require("../util/visit-import")
/**
* @typedef {[
* {
* allowModules?: import('../util/get-allow-modules').AllowModules;
* convertPath?: import('../util/get-convert-path').ConvertPath;
* resolvePaths?: import('../util/get-resolve-paths').ResolvePaths;
* resolverConfig?: import('../util/get-resolver-config').ResolverConfig;
* tryExtensions?: import('../util/get-try-extensions').TryExtensions;
* ignoreTypeImport?: boolean;
* ignorePrivate?: boolean;
* }?
* ]} RuleOptions
*/
/** @type {import('./rule-module').RuleModule<{RuleOptions: RuleOptions}>} */
module.exports = {
meta: {
docs: {
description:
"disallow `import` declarations which import private modules",
recommended: true,
url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-unpublished-import.md",
},
type: "problem",
fixable: null,
schema: [
{
type: "object",
properties: {
allowModules: getAllowModules.schema,
convertPath: getConvertPath.schema,
resolvePaths: getResolvePaths.schema,
resolverConfig: getResolverConfig.schema,
tryExtensions: getTryExtensions.schema,
ignoreTypeImport: { type: "boolean", default: false },
ignorePrivate: { type: "boolean", default: true },
},
additionalProperties: false,
},
],
messages,
},
create(context) {
const filePath = context.filename ?? context.getFilename()
const options = context.options[0] || {}
const ignoreTypeImport = options.ignoreTypeImport ?? false
const ignorePrivate = options.ignorePrivate ?? true
if (filePath === "<input>") {
return {}
}
return visitImport(context, { ignoreTypeImport }, targets => {
checkPublish(context, filePath, targets, { ignorePrivate })
})
},
}