Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
watskeburt
Advanced tools
Readme
Get changed files & their statuses since any git revision
A micro-lib to retrieve an array of file names that were changed since a revision. Also sports a cli for use outside of JavaScript c.s.
I needed something simple and robust to support some upcoming features in dependency-cruiser and to run standalone to use in combination with dependency-cruiser.
There are a few specialized packages like this on npm, but it seems they've fallen out of maintenance. More generic packages are still maintained, but for just this simple usage they're a bit overkill.
// const { listSync, getSHASync } = require("watskeburt"); // in commonjs contexts you can also require it
import { listSync, getSHASync } from "watskeburt";
// print the SHA1 of the current HEAD
console.log(getSHASync());
// list all files that differ between 'main' and the current revision (including
// files not staged for commit and files not under revision control)
/** @type {import('watskeburt').IChange[]} */
const lChangedFiles = listSync("main");
// list all files that differ between 'v0.6.1' and 'v0.7.1' (by definition
// won't include files staged for commit and/ or not under revision control)
/** @type {import('watskeburt').IChange[]} */
const lChangedFiles = listSync("v0.6.1", "v0.7.1");
// As a third parameter you can pass some options
// (pass null as the second parameter if you only want to compare between
// a revision and the working tree):
/** @type {import('watskeburt').IChange[]|string} */
const lChangedFiles = listSync("main", null, {
trackedOnly: false, // when set to true leaves out files not under revision control
outputType: "object", // other options: "json" and "regex" (as used in the CLI)
});
The array of changes this returns looks like this:
[
{
name: "doc/cli.md",
changeType: "modified",
},
{
name: "test/thing.spec.mjs",
changeType: "renamed",
oldName: "test/old-thing.spec.mjs",
},
{
name: "src/not-tracked-yet.mjs",
changeType: "untracked",
},
];
For now there's also a simple command line interface
# list all JavaScript-ish files changed since main in a regular expression
$ npx watskeburt main
^(src/cli.mjs|src/formatters/regex.mjs|src/version.mjs)$
By default this returns a regex that contains all changed files that could be
source files in the JavaScript ecosystem (.js, .mjs, .ts, .tsx ...) that can
be used in e.g. the --focus
and --reaches
filters of dependency-cruiser.
The JSON output (which looks a lot like the array above) is unfiltered and also contains other extensions.
Usage: cli [options] [revision]
lists files & their statuses since [revision].
-> When you don't pass a revision the revision defaults to the current one.
Options:
-V, --version output the version number
-T, --output-type <type> json,regex (default: "regex")
--tracked-only only take tracked files into account (default: false)
-h, --help display help for command
watskeburt is a fast pronunciation of the Dutch "wat is er gebeurd?" (what has happened?) or "wat er is gebeurd" (what has happened). It's also the title of a song by the Dutch band "De Jeugd van Tegenwoordig" (Youth these days...).
FAQs
List files changed since a git revision
The npm package watskeburt receives a total of 240,575 weekly downloads. As such, watskeburt popularity was classified as popular.
We found that watskeburt demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.