@cap-js/cds-typer 0.2.5-beta.1 → 0.4.0

package/CHANGELOG.md

@@ -4,11 +4,24 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 0.4.1 - TBD
 
-## Version 0.2.5-beta.1 - 2023-06-13
+## Version 0.4.0 - 2023-07-06
+### Added
+- Support for enums when they are defined separately (not inline in the property type of an entity)
 
+## Version 0.3.0 - 2023-06-26
+### Added
+- Support `function` definitions (apart from `action`s)
 ### Changed
+- Bump version to next minor
+
+### Fixed
+- Properly import CDS `type` definitions when they are referenced elsewhere
 
+## Version 0.2.5-beta.1 - 2023-06-13
+
+### Changed
 - Bump version
 
 ## Version 0.2.4 - 2023-06-12

package/README.md

@@ -6,16 +6,12 @@ Generates `.ts` files for a CDS model to receive code completion in VS Code.
 
 
 ## Requirements and Setup
-
-
-### Building the Project Yourself
-Clone the repository and install the dependencies running `npm i` from the project's root directory.
-
+This project is [available as `@cap-js/cds-typer`](https://www.npmjs.com/package/@cap-js/cds-typer) as NPM package.
 
 ### Usage
-The type generator is currently meant as a standalone tool and can be installed and used independently of other CDS environments (sans its dependency to the cds compiler).
+The type generator can either be used as a standalone tool, or as part of of the [CDS VSCode-Extension](https://www.npmjs.com/package/@sap/vscode-cds).
 
-#### Quickstart
+#### Standalone CLI
 Assuming you have the following CDS project structure:
 
 ```
@@ -30,38 +26,31 @@ Assuming you have the following CDS project structure:
 a typical workflow to generate types for your CDS project could look something like this:
 
 ```sh
-git clone https://this/repo cds-js-type-generator
-cd cds-js-type-generator
-npm i
-node ./index.js \
-  --rootDir /home/mybookshop/@types \
-  --jsConfigPath /home/mybookshop \
-  /home/mybookshop/srv/schema.cds
+npx @cap-js/cds-typer /home/mybookshop/db/schema.cds --outputDirectory /home/mybookshop/@types
 ```
 
-You would then end up with a `jsconfig.json` file in the project's root and a directory `@types`, which contains your entities and their accompanying types in a directory structure. The directory structure directly reflects the namespaces you have defined your entities in. They have to be imported in any JavaScript-based service handlers you want to have type support in and can replace calls to `cds.entities(...)`:
+You would then end up with a directory `@types`, which contains your entities and their accompanying types in a directory structure. The directory structure directly reflects the namespaces you have defined your entities in. They have to be imported in any JavaScript-based service handlers you want to have type support in and can replace calls to `cds.entities(...)`:
 
 ```js
 // srv/service.js
 const { Books } = require('my.bookshop')
-
 ```
 
 becomes
 
 ```js
 // srv/service.js
-
 const { Books } = require('../@types/mybookshop')
 ```
 
 From that point on you should receive code completion from the type system for `Books`.
 
-#### CLI
+_Note:_ the above command generates types for the model contained within the mentioned `schema.cds` file. If you have multiple `.cds` files that are included via `using` statements by `schema.cds`, then those files will also be included in the type generation process. If you have `.cds` files that are _not_ in some way included in `schema.cds`, you have to explicitly pass those as positional argument as well, if you want types for them.
+
 _cds-typer_ comes with rudimentary CLI support and a few command line options:
 
 - `--help`: prints all available parameters.
-- `--rootDir`: specifies the root directory where all generated files should be put. Defaults to the CWD.
+- `--outputDirectory`: specifies the root directory where all generated files should be put. Defaults to the CWD.
 - `--jsConfigPath`: specifies the path to the `jsconfig.json` file to generate. Usually your project's root directory. If specified, a config file is created that restricts the usage of types even further:
 
 ```js
@@ -93,11 +82,13 @@ NONE
 The utility expects (at least) one path to a `.cds` file as positional parameter which serves as entry point to the model in question, e.g.:
 
 ```sh
-cds-typer ./path/to/my/model/model.cds --rootDir /tmp/
+npx @cap-js/cds-typer ./path/to/my/model/model.cds --outputDirectory /tmp/
 ```
 
 Note that you can also pass multiple paths or `"*"` as glob pattern (with quotes to circumvent expansion by the shell). This passes the pattern on to the compiler where the [regular resolve strategy](https://cap.cloud.sap/docs/node.js/cds-compile?q=compiler#cds-resolve) is used.
 
+#### From VSCode
+Installing the [CDS VSCode Extension](https://www.npmjs.com/package/@sap/vscode-cds) also adds support for generating types for your model from within VSCode. Adding the appropriate facet to your project via `cds add typer` (and installing the added dependencies thereafter) allows you to simply hit save on any `.cds` file that is part of your model to trigger the generation process.
 #### Programmatically
 The main API for using _cds-typer_ within another project is contained in [`compile.js`](https://github.tools.sap/cap/cds-typer/blob/master/lib/compile.js), specifically:
 
@@ -181,7 +172,7 @@ _cds-typer_ tries to keep its dependency footprint as small as possible. Librari
 
 ## Support, Feedback, Contributing
 
-This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/cds-dts-generator/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/cds-typer/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
 
 ## Code of Conduct