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

neox-cli

v2.2.0

Published

Cross typescript interfaces, types and more!

Downloads

92

Readme

🚀 neoX

npm version License: MIT

📝 Description

neoX is a powerful CLI tool and library that aims to solve the problem of duplicated TypeScript interfaces and types across different codebases. By allowing you to create a centralized repository (public or private) with all your shared TypeScript definitions, you can easily manage and synchronize them in your projects. It even allows you to include a custom tsconfig.json for more advanced usage.

🛠 Installation

Local Installation

npm install neox-cli

or

yarn add neox-cli

Global Installation

Install neox-cli globally for system-wide accessibility.

npm install -g neox-cli

or

yarn global add neox-cli

⚡ Quick Start

After installing the package, use the CLI like so:

For local installation:

npx neox-cli init

For global installation:

neox-cli init

Or using the alias:

neox init

📘 Usage

CLI

Initialization

Run neox-cli init or its alias neox init to set up your centralized type repository.

neoX init

This creates a neoX.config.json in your current directory with recommended settings.

Pulling Types

To update your local type definitions from your centralized repository, run:

neox-cli pull

or its alias

neox pull

Advanced Usage: Custom tsconfig.json

neoX allows you to include a custom tsconfig.json in your centralized repository for advanced type management. To leverage this in your project, you can extend it like so:

{
  "extends": "./.neoX/tsconfig.json",
  // your custom overrides here
}

This gives you the freedom to set up paths, aliases, or any other TypeScript compiler options for the types you're pulling in.

Programmatic Use

neoX can also be integrated directly into your TypeScript projects. More documentation to come.

📦 API

init()

Initializes neoX, setting up a neoX.config.json in the current directory.

pull()

Updates your local type definitions from your centralized type repository.

📣 Contributing

  1. Fork the repo (https://github.com/EternalC0der/neox-cli/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

📝 License

MIT © EternalC0der