Giter Club home page Giter Club logo

node-modules-check's Introduction

ARCHIVED

This project has been discontinued.

Please use alternatives like

Node Modules Check

Description

This script looks up your package.json and tells you if there are any outdated packages. In case of outdated packages the script returns an exit code 1, otherwise 0. It uses npm outdated --json under the hood.

Features

  • ignore specific packages to be marked as outdated
  • sort packages by version difference (major → minor → patch)
  • indicate version difference by color
  • display type of dependency
  • show the homepage setting from the package.json of the outdated package

Installation

npm install --save-dev @sum.cumo/node-modules-check

Usage

check-node-modules

Configuration

You can set up packages that should be ignored in a configuration file.

Example:

{
  "ignore": ["eslint"],
  "ignoreRegex": [
    "([a-z])." //regex can be used as well
  ],
  "ignoreDev": true, // ignore dev dependencies
  "ignoreSemver": [
    // ignore semantic version
    "prerelease"
  ]
}

The configuration file can be specified through

check-node-modules --config path/to/some/config/file

or by placing a file named .check-node-modules.config.json in your projects folder.

Purpose example: GitLab CI

At sum.cumo we run this check in a scheduled pipeline in GitLab CI in order to check for outdated node modules regularly and automatically.

Dev workflow

  1. npm install
  2. ./bin/check.js

This will run the package on itself.

SVG creation

Dependencies
Commands
  1. Create the .cast file:
    asciinema rec node-modules-check.cast
  2. Create the .svg file:
    cat node-modules-check.cast | svg-term-cli --out node-modules-check.svg --profile=Seti --height=30 --width=100 --term iterm2 --window

License

Copyright 2019 sum.cumo GmbH

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


Learn more about sum.cumo and work on open source projects, too!

node-modules-check's People

Contributors

depfu[bot] avatar escapedcat avatar j9t avatar oooble avatar svewag avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

node-modules-check's Issues

Return list of update commands?

A suggestion, perhaps we could, upon inspection, return a list of update commands (or one update command) to just copy/modify and execute?

That is, instead of returning

   │      If you want to upgrade to the latest version, please run:         │
   │                  npm install <package>@latest                          │
   │   This will update your package.json and install the latest version.   │

return something like

   │      If you want to upgrade to the latest versions, please run:         │
   │             npm install foo@latest bar@latest baz@latest                │
   │   This will update your package.json and install the latest versions.   │

Perhaps this could be a nice option, too, like offering check-node-modules --update-all or something. TBD.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.