cddl2ts 0.3.1 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.release-it.ts ADDED
@@ -0,0 +1,14 @@
1
+ import baseConfig from '../../.release-it.base';
2
+ import type { Config } from 'release-it';
3
+
4
+ const config: Config = {
5
+ ...baseConfig,
6
+ git: {
7
+ ...baseConfig.git,
8
+ // Must be overriden by each package to have seperate tags and changelogs
9
+ tagName: "cddl2ts-v${version}",
10
+ commitMessage: "chore(cddl2ts): release v${version}",
11
+ },
12
+ };
13
+
14
+ export default config;
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2023 Christian Bromann<mail@bromann.dev>
3
+ Copyright (c) 2026 Christian Bromann
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,12 +1,9 @@
1
- CDDL to TypeScript [![Test](https://github.com/christian-bromann/cddl2ts/actions/workflows/test.yml/badge.svg)](https://github.com/christian-bromann/cddl2ts/actions/workflows/test.yml)
1
+ CDDL to TypeScript
2
2
  ==================
3
3
 
4
4
  > A Node.js package that can generate a TypeScript definition based on a CDDL file
5
5
 
6
- CDDL expresses Concise Binary Object Representation (CBOR) data structures ([RFC 7049](https://tools.ietf.org/html/rfc7049)). Its main goal is to provide an easy and unambiguous way to express structures for protocol messages and data formats that use CBOR or JSON. This package allows you to transform a CDDL file into a TypeScript interface that you can use for other TypeScript project.
7
-
8
- Related projects:
9
- - [christian-bromann/cddl](https://github.com/christian-bromann/cddl): parses CDDL into an AST
6
+ CDDL expresses Concise Binary Object Representation (CBOR) data structures ([RFC 7049](https://tools.ietf.org/html/rfc7049)). Its main goal is to provide an easy and unambiguous way to express structures for protocol messages and data formats that use CBOR or JSON. This package allows you to transform a CDDL file into a TypeScript interface that you can use for other TypeScript projects.
10
7
 
11
8
  ## Install
12
9
 
@@ -28,11 +25,10 @@ npx cddl2ts ./path/to/interface.cddl &> ./path/to/interface.ts
28
25
 
29
26
  ### Programmatic Interface
30
27
 
31
- The module exports a `transform` method that takes an CDDL AST object and returns a TypeScript definition as `string`, e.g.:
28
+ The module exports a `transform` method that takes a CDDL AST object and returns a TypeScript definition as `string`, e.g.:
32
29
 
33
30
  ```js
34
- import { parse } from 'cddl'
35
- import { transform } from 'cddl2ts'
31
+ import { parse, transform } from 'cddl'
36
32
 
37
33
  /**
38
34
  * spec.cddl:
@@ -61,4 +57,4 @@ console.log(ts)
61
57
 
62
58
  ---
63
59
 
64
- If you are interested in this project, please feel free to contribute ideas or code patches. Have a look at our [contributing guidelines](https://github.com/christian-bromann/cddl2ts/blob/master/CONTRIBUTING.md) to get started.
60
+ If you are interested in this project, please feel free to contribute ideas or code patches. Have a look at our [contributing guidelines](https://github.com/webdriverio/cddl/blob/master/CONTRIBUTING.md) to get started.
@@ -0,0 +1,6 @@
1
+ import rootConfig from '../../changelogithub.base.config.js'
2
+ import { defineConfig } from 'changelogithub'
3
+
4
+ export default defineConfig({
5
+ ...rootConfig,
6
+ })