Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grafana/levitate
A tool for helping to understand APIs exported and consumed by NPM packages (or any TypeScript code).
https://github.com/grafana/levitate
Last synced: about 2 months ago
JSON representation
A tool for helping to understand APIs exported and consumed by NPM packages (or any TypeScript code).
- Host: GitHub
- URL: https://github.com/grafana/levitate
- Owner: grafana
- License: apache-2.0
- Created: 2021-11-29T13:44:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T08:15:18.000Z (5 months ago)
- Last Synced: 2024-04-14T02:55:51.611Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 31.3 MB
- Stars: 24
- Watchers: 118
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE_APACHE2
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 🔮 Levitate
[![npm version][npm-badge]][npm-url]
[![npm downloads][downloads-badge]][npm-url]
[![CI][build-badge]][build-url]
[![prettier][prettier-badge]][prettier-url]
[![TypeScript][typescript-badge]][typescript-url]
A tool for helping to understand APIs exported and consumed by NPM packages (or any TypeScript code).
## Usage
**Compare exports of different package versions**
```bash
# Compare exports of different versions of a package
npx @grafana/levitate compare \
--prev @grafana/[email protected] \
--current @grafana/ui@canary
```
**List imports**
```bash
# List the imports used by a program
npx @grafana/levitate list-imports \
--path /module.ts \
--filters "@common/pages" "@grafana/data" \
--verbose
```
**List exports**
```bash
# List the exports of a compiled package
npx @grafana/levitate list-exports \
--path /index.d.ts
```
**Check compatibility between a module and a package**
To check the compatibility of code using a specific version of a package (e.g.: @grafana/[email protected])
against another version of the same package (e.g. @grafana/[email protected]).
```bash
# Check if the current module.ts usage of @grafana/data is
# compatible with the latest version of it
npx @grafana/levitate is-compatible \
--path /module.ts \
--target "@grafana/data@latest"
```
## Ignore specific exports changes
To ignore changes (add, change, remove) from specific export names you can create a `.levignore.js` file in the same directory where you invoke levitate.
The format of this file should be as follows:
```javascript
module.exports = {
removals: [
// each entry is a regex
/Sample\.ignoreThisOne/,
/Sample\.ignoreThisOneToo/,
/Sample.*\b/,
'Sample.ignoreThisOneToo', // strings are converted to regex to match exact
],
changes: [
//...
],
additions: [
//...
],
};
```
Note:
- Levitate will ignore symbols matching the regexes in any of the packages it inspects. If several packages export the same symbol name, they all will be ignored.
- This only affects the `compare` and `is-compatible` commands. It doesn't affect the `list-imports` or `list-exports` commands.
- You should locate your `.levignore.js` file in the same directory where you invoke levitate.
## Contributing
If you are interested in contributing to the Levitate project please read the [Contributing guide](https://github.com/grafana/levitate/blob/HEAD/CONTRIBUTING.md).
[npm-url]: https://www.npmjs.com/package/@grafana/levitate
[npm-badge]: https://img.shields.io/npm/v/@grafana/levitate.svg
[downloads-badge]: https://img.shields.io/npm/dm/@grafana/levitate.svg?color=blue
[build-badge]: https://github.com/grafana/levitate/actions/workflows/ci.yml/badge.svg
[build-url]: https://github.com/grafana/levitate/actions/workflows/ci.yml
[typescript-badge]: https://badges.frapsoft.com/typescript/code/typescript.svg?v=101
[typescript-url]: https://github.com/microsoft/TypeScript
[prettier-badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg
[prettier-url]: https://github.com/prettier/prettier