npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eslint-plugin-no-imports

v2.0.2

Published

Eslint plugin to prohibit imports outside specific directories.

Downloads

87

Readme

eslint-plugin-no-imports

npm NPM total downloads

An eslint rule to protect your modules from bad imports. It prohibits writing imports that go beyond the directories specified by you.

Installation

yarn add -D eslint-plugin-no-imports

or

npm install -D eslint-plugin-no-imports

Description

Below is a file structure where packages/brand and packages/analytics are independent modules from the project.

They can only import files that are within the same directories. Going beyond the specified directories is prohibited.

For example, the brand/index.js file can import brandFile.js but cannot import srcFile.js or analytics/*.js files, because it is outside the brand directory.

└── src/
    ├── srcFile.js
    └── packages/
        ├── brand/
        │   ├── index.js
        │   └── brandFile.js
        └── analytics/
            └── ...

How to use:

Add to your .eslintrc:

"plugins": ["no-imports"],
"rules": {
    "no-imports/outside-special-folder": [
      'error',
      {
        directories: ['./src/packages/brand', './src/packages/analytics'],
        aliases: [{ alias: 'app', pathToFolder: './src' }, { alias: '@', pathToFolder: './modules' }],
        ignore: ['./bin/**/*'],
      },
    ],
}

Examples:

/brand/index.js

✅ Good - These files are located in the `brand` directory. Everything is fine here. 
import data from './brandData';
import utils from 'alias/packages/brand/utils';

❌ Error - These files are outside the `brand` directory, so we will get an error.  
import constants from '../packagesConstants';
import utils from '../../srcUtils';
import data from '@/data';

If you add an ignore section as shown in (How to use), eslint will not complain about these directories/files.

/brand/index.js

✅ Good - The `bin` directory is located in the ignore section. Everything is fine here. 
import binConstaints from '../../../bin/constaints';

Windows

When specifying a folder path in the sections: directories, ignore, aliases - using escape characters is prohibited. Otherwise, it will break the logic for Windows users.

Options

| Name | Required | Description | |-------------|-----------------|-----------------------------------------------------------------------------------------------------------------| | directories | + | List of directories we are monitoring. If an import goes beyond the established directory, we receive an error. | | ignore | - | List of directories that are exceptions. | | aliases | - | If you have imports specified via aliases, you need to specify them here as well. |