Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@ts-graphviz/common
Advanced tools
@ts-graphviz/common - npm Package Compare versions
Comparing version 0.0.0-pr956-20240225091623 to 0.0.0-pr956-20240225160253
292
CHANGELOG.md
| # @ts-graphviz/common | ||
| ## 0.0.0-pr956-20240225091623 | ||
| ## 0.0.0-pr956-20240225160253 | ||
| ### Major Changes | ||
| - [`6b2f0e8`](https://github.com/ts-graphviz/ts-graphviz/commit/6b2f0e8349605b4fe0dd950147ba3a8285b24b24) Thanks [@kamiazya](https://github.com/kamiazya)! - Release v2.0.0 | ||
| - [`6b2f0e8`](https://github.com/ts-graphviz/ts-graphviz/commit/6b2f0e8349605b4fe0dd950147ba3a8285b24b24) Thanks [@kamiazya](https://github.com/kamiazya)! - # ts-graphviz v2 | ||
| ## 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: | ||
| 1. **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. | ||
| 2. **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. | ||
| 3. **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](#nodejs-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: | ||
| 1. **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. | ||
| 2. **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. | ||
| 3. **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. | ||
| 4. **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. | ||
| 5. **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. | ||
| 6. **Extensibility**: ts-graphviz has been designed with extensibility in mind, allowing users to extend its functionality with custom implementations for specific use cases. | ||
| 7. **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](https://www.npmjs.com/package/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](https://www.npmjs.com/package/@ts-graphviz/common) | Graphviz Types and Utilities | Contains type information related to DOT language attributes, attribute values, and models. | | ||
| | [@ts-graphviz/ast](https://www.npmjs.com/package/@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](https://www.npmjs.com/package/@ts-graphviz/core) | Graphviz Models for Object-Oriented Programming | Comprises the implementation of models and functions provided to users. | | ||
| | [@ts-graphviz/adapter](https://www.npmjs.com/package/@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: | ||
| 1. **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. | ||
| 2. **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. | ||
| 3. **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. | ||
| 4. **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: | ||
| 1. **Check Node.js Version**: First, check the version of Node.js used in your project by running the following command in your terminal: | ||
| ```sh | ||
| node -v | ||
| ``` | ||
| 2. **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. | ||
| 3. **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. | ||
| 4. **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`. | ||
| ```diff | ||
| - 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: | ||
| 1. **Update Import Statements**: Update import statements in your code to use the new module name. | ||
| ```diff | ||
| - import { } from 'ts-graphviz/adapter'; | ||
| + import { } from '@ts-graphviz/adapter'; | ||
| ``` | ||
| 2. **Update Package.json**: Update the `ts-graphviz` dependency in your `package.json` file to use the new version of the `@ts-graphviz/adapter` module. | ||
| ```diff | ||
| - "ts-graphviz": "^1.0.0", | ||
| + "ts-graphviz": "^2.0.0", | ||
| + "@ts-graphviz/adapter": "^2.0.0", | ||
| ``` | ||
| 3. **Update Code References**: Search your codebase for any references to the `ts-graphviz/adapter` module and update them to use the new module name. | ||
| ```diff | ||
| - 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: | ||
| 1. **Update Import Statements**: Update import statements in your code to use the new module name. | ||
| ```diff | ||
| - import { } from 'ts-graphviz/ast'; | ||
| + import { } from '@ts-graphviz/ast'; | ||
| ``` | ||
| 2. **Update Package.json**: Update the `ts-graphviz` dependency in your `package.json` file to use the new version of the `@ts-graphviz/ast` module. | ||
| ```diff | ||
| - "ts-graphviz": "^1.0.0", | ||
| + "ts-graphviz": "^2.0.0", | ||
| + "@ts-graphviz/ast": "^2.0.0", | ||
| ``` | ||
| 3. **Update Code References**: Search your codebase for any references to the `ts-graphviz/ast` module and update them to use the new module name. | ||
| ```diff | ||
| - 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 | ||
| ```diff | ||
| -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 | ||
| ```diff | ||
| - 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. |
@@ -33,3 +33,3 @@ function _pipe(...args) { | ||
| const RootModelsContext = Object.seal({ | ||
| // NOTE: RootModelsContext is also initialized after the model class is declared in the 'core/index.js' module. | ||
| // NOTE: RootModelsContext is also initialized after the model class is declared in the '@ts-graphviz/core/register-default' module. | ||
| Graph: null, | ||
@@ -36,0 +36,0 @@ Digraph: null, |
| { | ||
| "name": "@ts-graphviz/common", | ||
| "version": "0.0.0-pr956-20240225091623", | ||
| "description": "", | ||
| "version": "0.0.0-pr956-20240225160253", | ||
| "description": "Graphviz Types and Utilities", | ||
| "keywords": [ | ||
@@ -6,0 +6,0 @@ "graphviz", |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by9.33%
227388
No dependency changes