Code Monkey home page Code Monkey logo

nudge's Introduction

Nudge

Spot when implementations change, but docs don't.

Nudge suggests documentation that might need review based on changes to implementations. It does this by looking at your commit history, parsing the files with changes, and flagging unchanged comments on changed code. Nudge integrates nicely with CI pipelines and IDEs to make it easy to keep documentation up to date.

Usage

Run nudge in your repository to check unstaged changes. Alternatively, specify a revision range like --revisions=main..branch. Ignore file header-comments with --ignore-headers. To use Nudge with GitHub Actions, pass the --format=github option, which will annotate suggestions in the GitHub file viewer.

Nudge can work on any language that has a Tree-sitter grammar. Currently C, Go, and Rust are implemented.

Visual Studio Code Extension

When a supported file is saved, the extension checks all changes in your workspace and adds info squiggles under relevant documentation. Enable/disable linting with the 'Toggle Nudge' command.

nudge's People

Contributors

crummjyz avatar benjamin-davies avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

benjamin-davies

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.