V2 #956

kamiazya · 2024-02-18T17:05:20Z

Why?

Dropping support for Node.js 14 & 16

We are introducing a major version upgrade to ts-graphviz to ensure better performance, security, and compatibility with the latest improvements in the JavaScript ecosystem. With this upgrade, we will no longer support Node.js 14 & 16, which has reached its End-of-Life (EOL), and set the new minimum guaranteed version to Node.js 18.

This major version upgrade is necessary due to the following reasons:

Breaking Change: Dropping support for Node.js 14 & 16 is considered a breaking change, which requires a major version upgrade according to semantic versioning principles.
Improved Stability and Performance: By focusing on LTS versions, we can provide a library that benefits from the stability, long-term support, and performance improvements provided by newer Node.js versions.
Security: Ensuring that our library is compatible with the latest supported Node.js versions helps to minimize potential security vulnerabilities.

To help our users understand our approach to Node.js version support, we have established a clear Node.js Version Support Policy for ts-graphviz.

We encourage our users to update their projects to the latest LTS version of Node.js to ensure the best performance, security, and compatibility with ts-graphviz.

Key Concepts

ts-graphviz is a TypeScript library designed to create, manipulate, and render Graphviz DOT language graphs.

It is built around several key concepts that make it modular, extensible, and easy to use:

TypeScript-First Design & Type Definitions: ts-graphviz is designed with TypeScript as its primary language, providing strong typing and ensuring seamless integration with TypeScript projects. This enables users to leverage the full power of TypeScript's type system and tooling while working with Graphviz graphs. The library includes comprehensive type definitions for DOT language elements, making it easier to work with Graphviz elements in a type-safe manner.
Object-Oriented API: ts-graphviz provides an object-oriented API for creating and manipulating graph elements like graphs, nodes, and edges. This enables users to work with complex graph structures intuitively and efficiently.
Modular Design[New in v2]: The library is split into multiple packages, each serving a specific purpose. This modular design allows users to pick and choose the functionality they need, resulting in improved maintainability and flexibility.
AST Support: ts-graphviz includes a module for processing DOT language at the Abstract Syntax Tree (AST) level. This feature allows users to parse and generate DOT language while preserving its structure, making it easier to manipulate and transform graphs programmatically.
Runtime Adapter: The library provides adapter functions that enable users to execute Graphviz commands across different runtime environments, such as Node.js and Deno. These adapter functions serve as a wrapper, allowing for seamless integration with various platforms.
Extensibility: ts-graphviz has been designed with extensibility in mind, allowing users to extend its functionality with custom implementations for specific use cases.
Multi-Paradigm Support: ts-graphviz is designed to accommodate various programming paradigms, such as Object-Oriented Programming, Declarative Programming, and Functional Programming. This ensures that users can choose the programming style that best suits their needs and preferences, making it adaptable and versatile across different use cases and development approaches.

By combining these key concepts, ts-graphviz aims to provide a powerful and user-friendly tool for working with Graphviz DOT language in TypeScript projects.

What's changed?

Package splitting and monorepo-ization

Purpose

The purpose of package splitting and monorepo-ization in the ts-graphviz v2 is to achieve the following objectives:

Improved modularity: By separating functionality into distinct packages, the library becomes more modular. This allows users to install and use only the specific components they need, reducing unnecessary dependencies and improving overall performance.
Easier maintainability: Splitting the library into smaller packages makes it easier for developers to maintain and update each package independently. This allows for faster bug fixes, feature enhancements, and more efficient development cycles.
Clearer dependencies: Package splitting results in a more explicit dependency structure between components, making it easier for developers to understand and manage dependencies within the project.
Increased flexibility: With a modular package structure, users can choose to use only the features they need, making it easier to integrate ts-graphviz into a broader range of projects and applications.
Simplified collaboration: By breaking down the library into separate packages within a monorepo, contributors can focus on specific areas of interest without interfering with other parts of the library. This facilitates collaboration and encourages more developers to contribute to the project.
Centralized management: Monorepo-ization allows for the centralized management of all the packages. This enables developers to track issues, manage pull requests, and maintain documentation in a single location, increasing efficiency and reducing overhead.
Consistent versioning and releases: Monorepo-ization ensures that versioning and release processes are consistent across all packages, making it easier to maintain and update the library as a whole.

Overall, package splitting and monorepo-ization aim to create a more robust, maintainable, and user-friendly library that better serves the needs of the ts-graphviz community.

Packages

In v2 of ts-graphviz, the library functionality will be split into several packages. The packages to be split are as follows:

@ts-graphviz/common: Contains type information related to DOT language attributes, attribute values, and models.
@ts-graphviz/ast: Includes the module for processing DOT language at the AST (Abstract Syntax Tree) level.
@ts-graphviz/core: Comprises the implementation of models and functions provided to users.
@ts-graphviz/adapter: Handles runtime-dependent processing. For example, it provides I/O processing related to image generation in Graphviz on different runtimes, such as Node.js and Deno.

To ensure that existing users are not affected, the ts-graphviz package will remain available. This change will result in a clear division of functionality and will improve the scalability and maintainability of the project. However, users of previous versions and users who wish to use the library without extending it will be able to continue to use the ts-graphviz package as is.

ts-graphviz: The main package that serves as the entry point for users. It provides a high-level API for creating, manipulating, and rendering Graphviz DOT language graphs. This package depends on the other packages to provide its functionality.

Please note that while we strive to maintain compatibility, there might be some minor differences or limitations in the compatibility package compared to the original ts-graphviz library. It is essential to review the documentation and update your code accordingly if needed, but only when you decide to migrate to the new package structure.

Dependency graph

Package	Summary	Description
ts-graphviz	Graphviz library for TypeScript	The main package that serves as the entry point for users. It provides a high-level API for creating, manipulating, and rendering Graphviz DOT language graphs.
@ts-graphviz/common	Graphviz Types and Utilities	Contains type information related to DOT language attributes, attribute values, and models.
@ts-graphviz/ast	Graphviz AST(Abstract Syntax Tree) Utilities	Includes the module for processing DOT language at the AST (Abstract Syntax Tree) level.
@ts-graphviz/core	Graphviz Models for Object-Oriented Programming	Comprises the implementation of models and functions provided to users.
@ts-graphviz/adapter	Graphviz Runtime adapters for Cross Platform	Handles runtime-dependent processing, such as input/output processing and Renderer implementations for different environments.

Node.js Version Support Update

Starting with the upcoming release, ts-graphviz will no longer support Node.js 14 & 16, which has reached its End-of-Life (EOL). The new minimum guaranteed version will be Node.js 18. This decision allows us to focus on providing a secure and up-to-date library while minimizing the maintenance burden of supporting outdated versions.

To minimize disruption for our users, we have established a clear Node.js Version Support Policy for our library. This policy helps users understand our approach to Node.js version support and what to expect when using our library.

We encourage our users to update their projects to the latest LTS version of Node.js to ensure the best performance, security, and compatibility with ts-graphviz.

Node.js Version Support Policy

Our goal is to provide a stable and secure library for our users while keeping up with improvements in the JavaScript ecosystem. To achieve this, we have established the following Node.js version support policy for ts-graphviz:

Minimum Guaranteed Version: We guarantee support for the latest Node.js version that has entered Long-Term Support (LTS) at the time of a major release of our library. This ensures that our library benefits from the stability and long-term support provided by LTS versions.
End-of-Life (EOL) Policy: We will cease support for Node.js versions when they reach their EOL, as defined by the Node.js release schedule. This helps us focus on providing a secure and up-to-date library while minimizing the maintenance burden of supporting outdated versions.
Version Support Communication: We will communicate our Node.js version support policy in our library's documentation and release notes. When a new major version is released or when a Node.js version enters EOL, we will inform our users through release notes, blog posts, or other relevant channels.
Migration Guides : When introducing breaking changes due to Node.js version support updates, we will provide migration guides to help our users transition their projects to the new requirements smoothly.

Migration Guides

Update Node.js Version

To migrate to the new Node.js version support policy, follow these steps:

Check Node.js Version: First, check the version of Node.js used in your project by running the following command in your terminal:
```
node -v
```
Update Node.js: If your project is using Node.js 14 or 16, update it to the latest LTS version of Node.js (Node.js 18) by following the installation instructions provided on the official Node.js website or using a version manager like nvm or n.
Update Dependencies: After updating Node.js, review your project's dependencies to ensure that they are compatible with the new Node.js version. Update any dependencies that require changes to work with the latest LTS version of Node.js.
Test and Verify: Test your project with the updated Node.js version to ensure that it works as expected. Verify that all functionality is intact and that there are no compatibility issues with the new Node.js version.

By following these steps, you can migrate your project to the latest LTS version of Node.js and ensure compatibility with ts-graphviz.

Migrate `AttributeKeyDict` type to `Attribute.keys` type

AttributeKeyDict was deprecated in v1, so it was removed in v2.
Please modify to use Attribute.keys.

- import { AttributeKeyDict } from 'ts-graphviz';
+ import { Attribute } from '@ts-graphviz/common';

- const foo: AttributeKeyDict = ...;
+ const foo: Attribute.keys = ...;

Migrate `ts-graphviz/adapter` to `@ts-graphviz/adapter`

To migrate from the ts-graphviz/adapter module to the @ts-graphviz/adapter module, follow these steps:

Update Import Statements: Update import statements in your code to use the new module name.
```
- import { } from 'ts-graphviz/adapter';
+ import { } from '@ts-graphviz/adapter';
```
Update Package.json: Update the ts-graphviz dependency in your package.json file to use the new version of the @ts-graphviz/adapter module.
```
- "ts-graphviz": "^1.0.0",
+ "ts-graphviz": "^2.0.0",
+ "@ts-graphviz/adapter": "^2.0.0",
```
Update Code References: Search your codebase for any references to the ts-graphviz/adapter module and update them to use the new module name.
```
- import { } from 'ts-graphviz/adapter';
+ import { } from '@ts-graphviz/adapter';
```

Migrate `ts-graphviz/ast` to `@ts-graphviz/ast`

To migrate from the ts-graphviz/adapter module to the @ts-graphviz/adapter module, follow these steps:

Update Import Statements: Update import statements in your code to use the new module name.
```
- import { } from 'ts-graphviz/ast';
+ import { } from '@ts-graphviz/ast';
```
Update Package.json: Update the ts-graphviz dependency in your package.json file to use the new version of the @ts-graphviz/ast module.
```
- "ts-graphviz": "^1.0.0",
+ "ts-graphviz": "^2.0.0",
+ "@ts-graphviz/ast": "^2.0.0",
```
Update Code References: Search your codebase for any references to the ts-graphviz/ast module and update them to use the new module name.
```
- import { } from 'ts-graphviz/ast';
+ import { } from '@ts-graphviz/ast';
```

Migrate Extending the Type System

Common types moves to @ts-graphviz/common in v2.0.0.

If you have extended the type system, you need to update the import path.

Use Case: Specifying Custom Graph Layout and Output Formats

-import { $keywords } from 'ts-graphviz';
+import { $keywords } from '@ts-graphviz/common';
-import { toFile } from 'ts-graphviz/adapter';
+import { toFile } from '@ts-graphviz/adapter';

-// 1. Declare the 'ts-graphviz/adapter' module.
-declare module 'ts-graphviz/adapter' {
+// 1. Declare the '@ts-graphviz/adapter' module.
+declare module '@ts-graphviz/adapter' {
  export namespace Layout {
    // 2. Define the $values interface in the Layout namespace.
    // 3. Inherit from $keywords<'my-custom-algorithm'> and specify the name of the new layout engine in <...>.
    export interface $values extends $keywords<'my-custom-algorithm'> {}
  }

  export namespace Format {
    // 4. Define the $values interface in the Format namespace.
    // 5. Inherit from $keywords<'mp4'> and specify the name of the new output format in <...>.
    export interface $values extends $keywords<'mp4'> {}
  }
}

toFile('digraph { a -> b }', '/path/to/file', {
  layout: 'my-custom-algorithm',
  format: 'mp4',
});

Use Case: Adding Custom Attributes

- import { digraph, toDot, attribute as _, $keywords } from 'ts-graphviz';
+ import {  $keywords } from '@ts-graphviz'/common;
+ import { digraph, toDot, attribute as _ } from 'ts-graphviz';

-// 1. Declare the 'ts-graphviz' module.
-declare module 'ts-graphviz' {
+// 1. Declare the '@ts-graphviz/common' module.
+declare module '@ts-graphviz/common' {
  export namespace GraphAttributeKey {
    // 2. Define the $values interface in the GraphAttributeKey namespace.
    // 3. Inherit from $keywords<'hoge'> and specify the name of the new attribute in <...>.
    export interface $values extends $keywords<'hoge'> {}
  }

  export namespace Attribute {
    // 4. Define the $keys interface in the Attribute namespace.
    // 5. Inherit from $keywords<'hoge'> and specify the name of the new attribute in <...>.
    export interface $keys extends $keywords<'hoge'> {}

    // 6. Define the $types interface in the Attribute namespace.
    // 7. Specify the new attribute in the key and define its corresponding value in the value.
    export interface $types {
      hoge: string;
    }
  }
}

console.log(
  toDot(
    digraph((g) => {
      g.set(_.hoge, 'fuga');
    }),
  ),
);

Development

Package manager

Migration from yarn v1 to pnpm has been done for package management.

Build tool and Test suite

To enhance the development experience, the build tool has been changed from rollup to vite, and the test suite from jest to vitest. This was done because jest lacked standard support for monorepo integration and TypeScript, requiring the installation of additional plugins. However, vite and vitest handle these challenges more elegantly, providing a smoother and more efficient development workflow.

Release flow

The release flow has been updated to use the changeset tool to manage changes and releases.

This tool allows for a more streamlined and automated release process, making it easier to manage versioning and changelogs across multiple packages within the monorepo.

Linter an Formatter

The linter and formatter have been updated to use biome, respectively.

This change was made to ensure consistent code style and formatting across the entire codebase, making it easier to maintain and contribute to the project.

API Changes

The status of the ModelContext API and other APIs that were provided in beta and alpha have been removed. This is a temporary measure to ensure compliance with the @microsoft/api-extractor specification used internally in the d.ts file rollup.

coderabbitai · 2024-02-18T17:05:26Z

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

packages/ts-graphviz/src/ast/dot-shim/printer/plugins/utils/tokens.ts

github-actions · 2024-02-25T07:35:11Z

🫰✨ Thanks @kamiazya! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

# Use npm
npm install "@ts-graphviz/adapter"
# Use yarn
yarn add "@ts-graphviz/adapter"
# Use pnpm
pnpm add "@ts-graphviz/adapter"

# Use npm
npm install "@ts-graphviz/ast"
# Use yarn
yarn add "@ts-graphviz/ast"
# Use pnpm
pnpm add "@ts-graphviz/ast"

# Use npm
npm install "@ts-graphviz/common"
# Use yarn
yarn add "@ts-graphviz/common"
# Use pnpm
pnpm add "@ts-graphviz/common"

# Use npm
npm install "@ts-graphviz/core"
# Use yarn
yarn add "@ts-graphviz/core"
# Use pnpm
pnpm add "@ts-graphviz/core"

# Use npm
npm install @ts-graphviz/adapter@0.0.0-pr956-20240225073457
# Use yarn
yarn add @ts-graphviz/adapter@0.0.0-pr956-20240225073457
# Use pnpm
pnpm add @ts-graphviz/adapter@0.0.0-pr956-20240225073457

# Use npm
npm install @ts-graphviz/ast@0.0.0-pr956-20240225073457
# Use yarn
yarn add @ts-graphviz/ast@0.0.0-pr956-20240225073457
# Use pnpm
pnpm add @ts-graphviz/ast@0.0.0-pr956-20240225073457

# Use npm
npm install @ts-graphviz/common@0.0.0-pr956-20240225073457
# Use yarn
yarn add @ts-graphviz/common@0.0.0-pr956-20240225073457
# Use pnpm
pnpm add @ts-graphviz/common@0.0.0-pr956-20240225073457

# Use npm
npm install @ts-graphviz/core@0.0.0-pr956-20240225073457
# Use yarn
yarn add @ts-graphviz/core@0.0.0-pr956-20240225073457
# Use pnpm
pnpm add @ts-graphviz/core@0.0.0-pr956-20240225073457

# Use npm
npm install ts-graphviz@0.0.0-pr956-20240225073457
# Use yarn
yarn add ts-graphviz@0.0.0-pr956-20240225073457
# Use pnpm
pnpm add ts-graphviz@0.0.0-pr956-20240225073457

kamiazya · 2024-02-25T09:14:30Z

/snapshot-release

github-actions · 2024-02-25T09:16:39Z

🫰✨ Thanks @kamiazya! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

# Use npm
npm install "@ts-graphviz/adapter"
# Use yarn
yarn add "@ts-graphviz/adapter"
# Use pnpm
pnpm add "@ts-graphviz/adapter"

# Use npm
npm install "@ts-graphviz/ast"
# Use yarn
yarn add "@ts-graphviz/ast"
# Use pnpm
pnpm add "@ts-graphviz/ast"

# Use npm
npm install "@ts-graphviz/common"
# Use yarn
yarn add "@ts-graphviz/common"
# Use pnpm
pnpm add "@ts-graphviz/common"

# Use npm
npm install "@ts-graphviz/core"
# Use yarn
yarn add "@ts-graphviz/core"
# Use pnpm
pnpm add "@ts-graphviz/core"

# Use npm
npm install @ts-graphviz/adapter@0.0.0-pr956-20240225091623
# Use yarn
yarn add @ts-graphviz/adapter@0.0.0-pr956-20240225091623
# Use pnpm
pnpm add @ts-graphviz/adapter@0.0.0-pr956-20240225091623

# Use npm
npm install @ts-graphviz/ast@0.0.0-pr956-20240225091623
# Use yarn
yarn add @ts-graphviz/ast@0.0.0-pr956-20240225091623
# Use pnpm
pnpm add @ts-graphviz/ast@0.0.0-pr956-20240225091623

# Use npm
npm install @ts-graphviz/common@0.0.0-pr956-20240225091623
# Use yarn
yarn add @ts-graphviz/common@0.0.0-pr956-20240225091623
# Use pnpm
pnpm add @ts-graphviz/common@0.0.0-pr956-20240225091623

# Use npm
npm install @ts-graphviz/core@0.0.0-pr956-20240225091623
# Use yarn
yarn add @ts-graphviz/core@0.0.0-pr956-20240225091623
# Use pnpm
pnpm add @ts-graphviz/core@0.0.0-pr956-20240225091623

# Use npm
npm install ts-graphviz@0.0.0-pr956-20240225091623
# Use yarn
yarn add ts-graphviz@0.0.0-pr956-20240225091623
# Use pnpm
pnpm add ts-graphviz@0.0.0-pr956-20240225091623

kamiazya · 2024-02-25T16:01:25Z

/snapshot-release

github-actions · 2024-02-25T16:03:06Z

🫰✨ Thanks @kamiazya! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

# Use npm
npm install "@ts-graphviz/adapter"
# Use yarn
yarn add "@ts-graphviz/adapter"
# Use pnpm
pnpm add "@ts-graphviz/adapter"

# Use npm
npm install "@ts-graphviz/ast"
# Use yarn
yarn add "@ts-graphviz/ast"
# Use pnpm
pnpm add "@ts-graphviz/ast"

# Use npm
npm install "@ts-graphviz/common"
# Use yarn
yarn add "@ts-graphviz/common"
# Use pnpm
pnpm add "@ts-graphviz/common"

# Use npm
npm install "@ts-graphviz/core"
# Use yarn
yarn add "@ts-graphviz/core"
# Use pnpm
pnpm add "@ts-graphviz/core"

# Use npm
npm install @ts-graphviz/adapter@0.0.0-pr956-20240225160253
# Use yarn
yarn add @ts-graphviz/adapter@0.0.0-pr956-20240225160253
# Use pnpm
pnpm add @ts-graphviz/adapter@0.0.0-pr956-20240225160253

# Use npm
npm install @ts-graphviz/ast@0.0.0-pr956-20240225160253
# Use yarn
yarn add @ts-graphviz/ast@0.0.0-pr956-20240225160253
# Use pnpm
pnpm add @ts-graphviz/ast@0.0.0-pr956-20240225160253

# Use npm
npm install @ts-graphviz/common@0.0.0-pr956-20240225160253
# Use yarn
yarn add @ts-graphviz/common@0.0.0-pr956-20240225160253
# Use pnpm
pnpm add @ts-graphviz/common@0.0.0-pr956-20240225160253

# Use npm
npm install @ts-graphviz/core@0.0.0-pr956-20240225160253
# Use yarn
yarn add @ts-graphviz/core@0.0.0-pr956-20240225160253
# Use pnpm
pnpm add @ts-graphviz/core@0.0.0-pr956-20240225160253

# Use npm
npm install ts-graphviz@0.0.0-pr956-20240225160253
# Use yarn
yarn add ts-graphviz@0.0.0-pr956-20240225160253
# Use pnpm
pnpm add ts-graphviz@0.0.0-pr956-20240225160253

kamiazya · 2024-02-25T16:09:16Z

@coderabbitai review

changeset-bot · 2024-02-25T16:25:40Z

🦋 Changeset detected

Latest commit: f673adc

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages

Name	Type
ts-graphviz	Major
@ts-graphviz/adapter	Major
@ts-graphviz/common	Major
@ts-graphviz/core	Major
@ts-graphviz/ast	Major
@ts-graphviz-examples/deno	Patch
@ts-graphviz-examples/cjs	Patch
@ts-graphviz-examples/esm	Patch
@ts-graphviz-examples/typescript	Patch
@ts-graphviz-examples/webpack-build-node	Patch
@ts-graphviz-examples/webpack-build-web	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

kamiazya · 2024-02-25T16:34:53Z

/snapshot-release

github-actions · 2024-02-25T16:36:49Z

🫰✨ Thanks @kamiazya! Your snapshots have been published to npm.

Test the snapshots by updating your package.json with the newly published versions:

# Use npm
npm install "@ts-graphviz/adapter"
# Use yarn
yarn add "@ts-graphviz/adapter"
# Use pnpm
pnpm add "@ts-graphviz/adapter"

# Use npm
npm install "@ts-graphviz/ast"
# Use yarn
yarn add "@ts-graphviz/ast"
# Use pnpm
pnpm add "@ts-graphviz/ast"

# Use npm
npm install "@ts-graphviz/common"
# Use yarn
yarn add "@ts-graphviz/common"
# Use pnpm
pnpm add "@ts-graphviz/common"

# Use npm
npm install "@ts-graphviz/core"
# Use yarn
yarn add "@ts-graphviz/core"
# Use pnpm
pnpm add "@ts-graphviz/core"

# Use npm
npm install @ts-graphviz/adapter@0.0.0-pr956-20240225163634
# Use yarn
yarn add @ts-graphviz/adapter@0.0.0-pr956-20240225163634
# Use pnpm
pnpm add @ts-graphviz/adapter@0.0.0-pr956-20240225163634

# Use npm
npm install @ts-graphviz/ast@0.0.0-pr956-20240225163634
# Use yarn
yarn add @ts-graphviz/ast@0.0.0-pr956-20240225163634
# Use pnpm
pnpm add @ts-graphviz/ast@0.0.0-pr956-20240225163634

# Use npm
npm install @ts-graphviz/common@0.0.0-pr956-20240225163634
# Use yarn
yarn add @ts-graphviz/common@0.0.0-pr956-20240225163634
# Use pnpm
pnpm add @ts-graphviz/common@0.0.0-pr956-20240225163634

# Use npm
npm install @ts-graphviz/core@0.0.0-pr956-20240225163634
# Use yarn
yarn add @ts-graphviz/core@0.0.0-pr956-20240225163634
# Use pnpm
pnpm add @ts-graphviz/core@0.0.0-pr956-20240225163634

# Use npm
npm install ts-graphviz@0.0.0-pr956-20240225163634
# Use yarn
yarn add ts-graphviz@0.0.0-pr956-20240225163634
# Use pnpm
pnpm add ts-graphviz@0.0.0-pr956-20240225163634

kamiazya added 12 commits February 16, 2024 14:14

Migrate to pnpm and Update .gitignore

c7f7a1d

Migrate to Biome and Restyle code

13c4527

Migration from jest and Rollup.js to Vite and Vitest

83dbf15

Monorepolize with pnpm and turbo

85946c9

Add examples and integration tests

ac0eb6d

Fix build configs

493d10d

Update Node.js version to 20

f7ac670

Add changeset

3a1c74c

Refactor build and check workflows

c17db45

Remove release-drafter configuration file

25e1948

Improve

9f5f112

Fix for lint

bdb4fa3

kamiazya added 8 commits February 18, 2024 17:11

Add Deno setup for CI

dbfeb8a

Add turbo build setup caching

e09478f

Update GitHub Actions caching for Turbo

d2b773d

Remove unused Deno registry configurations

9c16ddf

Update pnpm/action-setup to v3.0.0

81a4aeb

Add @types/node

d8e89af

Update dependencies and pipeline in turbo.json

7f13250

Refactor Real World AST Snapshot tests

2f5dcbb

github-advanced-security bot found potential problems Feb 24, 2024

View reviewed changes

packages/ts-graphviz/src/ast/dot-shim/printer/plugins/utils/tokens.ts Fixed Show resolved Hide resolved

kamiazya added 8 commits February 24, 2024 05:05

Fix import statement in real-world.test.ts

438ad62

Add testAstSnapshot function to real-world.test.ts

b6e938d

Fix function signature in testAstSnapshot

be65aa1

Fix concurrent test failed

2100828

Remove unused function testAstSnapshot()

6159ece

Add lefthook

0ea2b47

Fix escape function to properly handle backslashes

e1ce1af

Remove postinstall script from package.json

8f333ae

kamiazya added 3 commits February 25, 2024 07:52

Update package.json files with additional files, funding, and keywords

48480d6

Add Node.js engine requirement to package.json files

4d9c472

Update package.json files

518d902

kamiazya added 6 commits February 25, 2024 13:19

Refactor core and update build settings

c5b23fb

Remove deprecated AttributeKeyDict type

8eb835a

Add privatePackages configuration

875b976

Update package descriptions and README

b5bbdca

Update Makefile to use pnpm instead of yarn for svgo

3b3db37

Update tsconfig.json to remove empty "include" array

408b288

kamiazya marked this pull request as ready for review February 25, 2024 16:01

kamiazya added 2 commits February 25, 2024 16:25

Add .npmignore files and update imports

742399c

Remove unnecessary files from package.json

5dfe2b7

Add src folder to .npmignore files

b0c9f11

kamiazya added 5 commits March 1, 2024 09:03

Update Suponser badge link

cb21ff7

Fix typedoc configuration

05ded4a

Add CD workflow for automated release process

06176d2

Update file extensions and dependencies in webpack build examples

d795cf1

Update typedoc.json file

f673adc

kamiazya changed the title V2 ts-graphviz v2 Mar 1, 2024

kamiazya changed the title ~~ts-graphviz v2~~ V2 Mar 1, 2024

kamiazya merged commit 1e4f57a into main Mar 1, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

V2 #956

V2 #956

kamiazya commented Feb 18, 2024 •

edited

coderabbitai bot commented Feb 18, 2024 •

edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

github-actions bot commented Feb 25, 2024

kamiazya commented Feb 25, 2024

github-actions bot commented Feb 25, 2024

kamiazya commented Feb 25, 2024

github-actions bot commented Feb 25, 2024

kamiazya commented Feb 25, 2024

changeset-bot bot commented Feb 25, 2024 •

edited

kamiazya commented Feb 25, 2024

github-actions bot commented Feb 25, 2024

V2 #956

V2 #956

Conversation

kamiazya commented Feb 18, 2024 • edited

Why?

Dropping support for Node.js 14 & 16

Key Concepts

What's changed?

Package splitting and monorepo-ization

Purpose

Packages

Dependency graph

Node.js Version Support Update

Node.js Version Support Policy

Migration Guides

Update Node.js Version

Migrate AttributeKeyDict type to Attribute.keys type

Migrate ts-graphviz/adapter to @ts-graphviz/adapter

Migrate ts-graphviz/ast to @ts-graphviz/ast

Migrate Extending the Type System

Use Case: Specifying Custom Graph Layout and Output Formats

Use Case: Adding Custom Attributes

Development

Package manager

Build tool and Test suite

Release flow

Linter an Formatter

API Changes

coderabbitai bot commented Feb 18, 2024 • edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

github-actions bot commented Feb 25, 2024

kamiazya commented Feb 25, 2024

github-actions bot commented Feb 25, 2024

kamiazya commented Feb 25, 2024

github-actions bot commented Feb 25, 2024

kamiazya commented Feb 25, 2024

changeset-bot bot commented Feb 25, 2024 • edited

🦋 Changeset detected

kamiazya commented Feb 25, 2024

github-actions bot commented Feb 25, 2024

kamiazya commented Feb 18, 2024 •

edited

Migrate `AttributeKeyDict` type to `Attribute.keys` type

Migrate `ts-graphviz/adapter` to `@ts-graphviz/adapter`

Migrate `ts-graphviz/ast` to `@ts-graphviz/ast`

coderabbitai bot commented Feb 18, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

changeset-bot bot commented Feb 25, 2024 •

edited