@cap-js/cds-typer 0.23.0 → 0.24.0

package/CHANGELOG.md

@@ -4,7 +4,16 @@ 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.24.0 - TBD
+## Version 0.25.0 - TBD
+
+## Version 0.24.0 - 2024-07-18
+### Fixed
+- Suppressed an error that would incorrectly point out naming clashes when an entity was named in singular inflection in the model
+- CDS aspects now also generate a aspect-function in singular inflection, similar to how entities do
+
+### Changed
+- Aspects generate named classes again so that tooltips will show more meaningful provenance for properties
+- The TypeScript task for `cds build` no longer looks for tsconfig.json to determine if the project has TS nature and instead checks the dependencies in the project's package.json for an occurrence of `typescript`
 
 ## Version 0.23.0 - 2024-07-04
 ### Fixed

package/cds-plugin.js

@@ -10,9 +10,14 @@ const DEBUG = cds.debug('cli|build')
 const BUILD_CONFIG = 'tsconfig.cdsbuild.json'
 
 /**
- * Check if a tsconfig file exists.
+ * Check if the project is a TypeScript project by looking for a dependency on TypeScript.
+ * @returns {boolean}
  */
-const tsConfigExists = () => fs.existsSync('tsconfig.json')
+const isTypeScriptProject = () => {
+    if (!fs.existsSync('package.json')) return false
+    const pkg = require(path.resolve('package.json'))
+    return Boolean(pkg.devDependencies?.typescript || pkg.dependencies?.typescript)
+}
 
 /**
  * Check if separate tsconfig file that is used for building the project.
@@ -56,7 +61,7 @@ if (!cds?.version || cds.version < '8.0.0') {
 // requires @sap/cds-dk version >= 7.5.0
 cds.build?.register?.('typescript', class extends cds.build.Plugin {
     static taskDefaults = { src: '.' }
-    static hasTask() { return tsConfigExists() }
+    static hasTask() { return isTypeScriptProject() }
 
     // lower priority than the nodejs task
     get priority() { return -1 }

package/lib/visitor.js

@@ -166,7 +166,7 @@ class Visitor {
 
         // CLASS ASPECT
         buffer.addIndentedBlock(`export function ${identAspect(clean)}<TBase extends new (...args: any[]) => object>(Base: TBase) {`, () => {
-            buffer.addIndentedBlock(`return class extends ${ancestors} {`, () => {
+            buffer.addIndentedBlock(`return class ${clean} extends ${ancestors} {`, () => {
                 const enums = []
                 for (let [ename, element] of Object.entries(entity.elements ?? {})) {
                     if (element.target && /\.texts?/.test(element.target)) {
@@ -250,7 +250,9 @@ class Visitor {
         }
 
         // as types are not inflected, their singular will always clash and there is also no plural for them anyway -> skip
-        if (!isType(entity) && `${ns.asNamespace()}.${singular}` in this.csn.xtended.definitions) {
+        // if the user defined their entities in singular form we would also have a false positive here -> skip
+        const namespacedSingular = `${ns.asNamespace()}.${singular}`
+        if (!isType(entity) && namespacedSingular !== fq && namespacedSingular in this.csn.xtended.definitions) {
             LOG.error(
                 `Derived singular '${singular}' for your entity '${fq}', already exists. The resulting types will be erronous. Consider using '@singular:'/ '@plural:' annotations in your model or move the offending declarations into different namespaces to resolve this collision.`
             )
@@ -372,14 +374,14 @@ class Visitor {
 
     #printAspect(fq, aspect) {
         LOG.debug(`Printing aspect ${fq}`)
-        const { namespace, entityName } = this.entityRepository.getByFq(fq)
+        const { namespace, entityName, inflection } = this.entityRepository.getByFq(fq)
         const file = this.fileRepository.getNamespaceFile(namespace)
         // aspects are technically classes and can therefore be added to the list of defined classes.
         // Still, when using them as mixins for a class, they need to already be defined.
         // So we separate them into another buffer which is printed before the classes.
         file.addClass(entityName, fq)
         file.aspects.add(`// the following represents the CDS aspect '${entityName}'`)
-        this.#aspectify(fq, aspect, file.aspects, { cleanName: entityName })
+        this.#aspectify(fq, aspect, file.aspects, { cleanName: inflection.singular })
     }
 
     #printEvent(fq, event) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-typer",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Generates .ts files for a CDS model to receive code completion in VS Code",
   "main": "index.js",
   "repository": "github:cap-js/cds-typer",