Skip to content

Commit

Permalink
chore: update versions (#158)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and github-actions[bot] committed Jun 11, 2024
1 parent 0871131 commit 65f879a
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 40 deletions.
39 changes: 0 additions & 39 deletions .changeset/thick-ties-hang.md

This file was deleted.

39 changes: 39 additions & 0 deletions packages/skott/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,44 @@
# skott

## 0.34.0

### Minor Changes

- [#157](https://github.com/antoine-coulon/skott/pull/157) [`0871131`](https://github.com/antoine-coulon/skott/commit/0871131b9e6eb4dfb80c8899df0ae4a5fdff8cb0) Thanks [@antoine-coulon](https://github.com/antoine-coulon)! - Expose a new rendering module providing a programmatic access to terminal and web visualizations through skott's API.

This is equivalent to use the CLI such as `skott --displayMode=webapp` but offers more flexibility for the runtime configuration which suffers from limitations when only using the CLI (some configurations are nearly impossible to represent using strings e.g. providing custom functions), this is why often authors tend to introduce runtime configuration files that CLIs can pick up automatically, thing that we want to avoid with skott, by unifying it's usage either coming from the API or CLI.

**Using the rendering module**

```js
import { defaultConfig } from "skott";
import { Web, Terminal } from "skott/rendering";

await Web.renderWebApplication(
// skott runtime config
defaultConfig,
// application config
{
visualization: {
granularity: "module",
},
watch: true,
port: 1111,
onListen: (port) => console.log(`Listening on port ${port}`),
open: true,
onOpenError: () => console.log(`Error when opening the browser`),
},
);

await Terminal.renderTerminalApplication(defaultConfig, {
displayMode: "graph",
exitCodeOnCircularDependencies: 1,
showCircularDependencies: true,
showUnusedDependencies: true,
watch: true,
});
```

## 0.33.2

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/skott/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "skott",
"version": "0.33.2",
"version": "0.34.0",
"description": "Automatically construct and visualize Graphs generated from your JavaScript and TypeScript project",
"author": "Antoine Coulon",
"license": "MIT",
Expand Down

0 comments on commit 65f879a

Please sign in to comment.