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

@epicinium/cognomen

v1.4.3

Published

A resolver in order to shorten deeply nested relative path expression.

Downloads

4

Readme

@epicinium/cognomen

A resolver in order to shorten deeply nested relative path expression.

Build StatusLicensePackage Version

Table of Contents

Motivation

In monorepo structure or complex directory hierarchy, we used to exhausted by deeply nested import expression. (e.g. import ... from '../../../../package.json' in packages/frontend/components/button/index.jsx)

Prior Art

Installation

$ npm install --save-dev @epicinium/cognomen

Integration

Babel

If import ... from '(frontend)/application' expression in backend/server.js file. that will be transformed like const ... = require('../frontend/releases/application').

{
    "plugins": [
        [
            "module:@epicinium/cognomen",
            {
                "frontend": "releases/frontend",
                "backend": "releases/backend"
            }
        ]
    ]
}

Write or append above codes into your Babel configuration file. (e.g. babel.config.js, .babelrc(.js(on)?)?)

Babel integration has to match to output directories. (e.g. dist, out, build, ...)

ESLint

If you want to integrate with ESLint, you have to ensure eslint-plugin-import installed. and then, set resolver to your configuration file.

{
    "settings": {
        "import/resolver": {
            "@epicinium/cognomen": {
                "frontend": "sources/frontend",
                "backend": "sources/backend"
            }
        }
    }
}

Write or append above codes into your ESLint configuration file. (e.g. .eslintrc(.js(on)?|.ya?ml)?)

ESLint integration has to match to source directories. (e.g. src, ...)

Visual Studio Code

In Visual Studio Code, all JavaScript files are analyzed by internal TypeScript language handler. so, you can just write jsconfig.json file or tsconfig.json for TypeScript project.

{
    "compilerOptions": {
        "baseUrl": ".",
        "paths": {
            "(frontend)/*": "sources/frontend/*",
            "(backend)/*": "sources/backend/*"
        }
    },
    "include": ["sources"]
}

Visual Studio Code integration has to wrap alias name with parentheses and match to source directories.

Usage

After the integration process, you can write code with aliased scopes. an alias name has to wrapped by parentheses for avoiding name collision with existing modules by indirect deep dependencies.

Before

- import logger from '../../../../common/logger';

After

+ import logger from '(common)/logger';

Trivia

cognomen means alias name or nickname in the Latin Language

License

MIT Licensed.