Skip to content

Publish the source files alongside the already published source maps on npm  #2807

Closed as not planned
@johenning

Description

@johenning

Is your feature request related to a problem? Please describe.
When reading Cloud SDK code in the installed module folder or when stepping through it while debugging, the code is not as readable as it could be, because only the compiled JavaScript files are available, not the original TypeScript files.

Cloud SDK packages published on npm only contain the dist folder, which in turn contains .js (results of TS compilation), .d.ts (type definition files) and .d.ts.map (source maps). They do not contain the original source code, though they are referenced in the source maps, e.g.:
@sap-cloud-sdk/connectivity/dist/scp-cf/destination/destination-from-service.d.ts.map

{"version":3,"file":"destination-from-service.d.ts","sourceRoot":"","sources":["../../../src/scp-cf/destination/destination-from-service.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAM1D,OAAO,EACL,uBAAuB,EAExB,MAAM,8BAA8B,CAAC;AAmFtC;;;;;;;GAOG;AACH,wBAAsB,oCAAoC,CACxD,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAK7B"}

I believe the only thing missing here is the src folder. If I copy the src from Github into my local installation everything works as expected.

Describe the solution you'd like
Publish the src folder for all packages (.spec.ts files are unnecessary though).

Alternatively, use inlineSources instead of sourceMap in https://github.com/SAP/cloud-sdk-js/blob/main/tsconfig.json.

Impact / Priority
Low, just a quality of life improvement.

Affected development phase: all

Impact: Inconvenience

Timeline: Not time sensitive

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions