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

@iceworks/doctor

v0.4.8

Published

Analyse and running codemods over react/rax projects, troubleshooting and automatically fixing errors

Downloads

16

Readme

Iceworks Doctor

Analyse and running codemods over react/rax projects, troubleshooting and automatically fixing errors.

1. Code Scanner

Installation

$ npm i @iceworks/doctor --save-dev

or

$ npm install -g @iceworks/doctor

Usage

const { Doctor } = require('@iceworks/doctor');

const doctor = new Doctor(options);
doctor.scan('/yourProjectPath').then((result) => {
  console.log(result);
});

Usage(CLI)

Use $ iceworks-doctor -h for help.

Scan

$ iceworks-doctor -s ./

Options

$ iceworks-doctor -s ./ --ignore types mock

Options

new Doctor(options?);

  • ignore?: string[], Ignore directories, example ['mock'] . .gitignore will work too.

scan('/yourProjectPath', options?);

  • fix?: boolean, whether fix ESLint fixable problems.
  • framework?: string, target project framework, default is react.
  • languageType?: 'js'|'ts', target project languageType, default is js.
  • tempFileDir?: string, set temp reporters file directory, default is node_modules/@iceworks/doctor/tmp/.
  • disableESLint?: boolean, whether disable ESLint part reports.
  • disableMaintainability?: boolean, whether disable maintainability part reports.
  • disableRepeatability?: boolean, whether disable repeatability part reports.

Result

ESLint

Use @iceworks/spec check your project.

.eslintrc.js customConfig will merge into ESLint config.

// .eslintrc.js
const { getESLintConfig } = require('@iceworks/spec');
 
// getESLintConfig(rule: 'rax'|'react', customConfig?);
module.exports = getESLintConfig('react', {
  'no-unused-vars': 'off'
});

.eslintignore ignore config will merge into ESLint ignore.

Maintainability

Use typhonjs-escomplex calculate complexity reports.

Repeatability

Use jscpd calculate repeatability reports.

2. Codemod

This repository also contains a collection of codemod scripts that help update React(ICE) and Rax APIs.

Installation

Install jscodeshift and @iceworks/doctor.

$ npm i -g jscodeshift @iceworks/doctor 

Usage (CLI)

iceworks-doctor -c <transform> <path?> [...options?]

  • transform - name of transform, see available transforms below.
  • path? - files or directory to transform.
  • options? - some rule's options.

This will start an interactive wizard, and then run the specified transform.

PS: You can also clone this repository then use jscodeshift's CLI API.

Included Transforms

plugin-rax-component-to-component

Update plugin-rax-component to plugin-component. See: https://rax.js.org/docs/guide/com-migration

iceworks-doctor -c plugin-rax-component-to-component ./

Enjoy!