Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FIX] Node.js API: TypeScript type definition support #335

Merged
merged 2 commits into from
Jul 14, 2020
Merged

[FIX] Node.js API: TypeScript type definition support #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70b1f1f
[FIX] TypeScript type definition support
matz3 Jun 24, 2020
5824c32
Add jsdoc plugin
matz3 Jul 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,28 @@
* @module module:@ui5/project
* @public
*/
const modules = {
module.exports = {
/**
* @type {import('./lib/normalizer')}
*/
normalizer: "./lib/normalizer",
/**
* @type {import('./lib/projectPreprocessor')}
*/
projectPreprocessor: "./lib/projectPreprocessor",
/**
* @public
* @alias module:@ui5/project.ui5Framework
* @namespace
*/
ui5Framework: {
/**
* @type {typeof import('./lib/ui5Framework/Openui5Resolver')}
*/
Openui5Resolver: "./lib/ui5Framework/Openui5Resolver",
/**
* @type {typeof import('./lib/ui5Framework/Sapui5Resolver')}
*/
Sapui5Resolver: "./lib/ui5Framework/Sapui5Resolver"
},
/**
Expand All @@ -20,7 +32,13 @@ const modules = {
* @namespace
*/
validation: {
/**
* @type {import('./lib/validation/validator')}
*/
validator: "./lib/validation/validator",
/**
* @type {typeof import('./lib/validation/ValidationError')}
*/
ValidationError: "./lib/validation/ValidationError"
},
/**
Expand All @@ -29,7 +47,13 @@ const modules = {
* @namespace
*/
translators: {
/**
* @type {import('./lib/translators/npm')}
*/
npm: "./lib/translators/npm",
/**
* @type {import('./lib/translators/static')}
*/
static: "./lib/translators/static"
}
};
Expand All @@ -49,4 +73,4 @@ function exportModules(exportRoot, modulePaths) {
}
}

exportModules(module.exports, modules);
exportModules(module.exports, JSON.parse(JSON.stringify(module.exports)));
13 changes: 13 additions & 0 deletions jsdoc-plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/*
* Removes JSDoc comments with TypeScript import() declarations (used in index.js)
*/

const IMPORT_PATTERN = /{(?:typeof )?import\(["'][^"']*["']\)[ .|}><,)=#\n]/;

exports.handlers = {
jsdocCommentFound: function(e) {
if (IMPORT_PATTERN.test(e.comment)) {
e.comment = "";
}
}
};
118 changes: 60 additions & 58 deletions jsdoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,60 +1,62 @@
{
"tags": {
"allowUnknownTags": false
},
"source": {
"include": ["README.md", "index.js"],
"includePattern": ".+\\.js$",
"excludePattern": "(node_modules(\\\\|/))"
},
"plugins": [],
"opts": {
"template": "node_modules/docdash/",
"encoding": "utf8",
"destination": "jsdocs/",
"recurse": true,
"verbose": true,
"access": "public"
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"default": {
"useLongnameInNav": true
}
},
"openGraph": {
"title": "UI5 Tooling - API Reference",
"type": "website",
"image": "https://sap.github.io/ui5-tooling/docs/images/UI5_logo_wide.png",
"site_name": "UI5 Tooling - API Reference",
"url": "https://sap.github.io/ui5-tooling/"
},
"docdash": {
"sectionOrder": [
"Modules",
"Namespaces",
"Classes",
"Externals",
"Events",
"Mixins",
"Tutorials",
"Interfaces"
],
"meta": {
"title": "UI5 Tooling - API Reference - UI5 Project",
"description": "UI5 Tooling - API Reference - UI5 Project",
"keyword": "openui5 sapui5 ui5 build development tool api reference"
},
"search": true,
"wrap": true,
"menu": {
"GitHub": {
"href": "https://github.com/SAP/ui5-project",
"target": "_blank",
"class": "menu-item",
"id": "github_link"
}
}
}
"tags": {
"allowUnknownTags": false
},
"source": {
"include": ["README.md", "index.js"],
"includePattern": ".+\\.js$",
"excludePattern": "(node_modules(\\\\|/))"
},
"plugins": [
"./jsdoc-plugin"
],
"opts": {
"template": "node_modules/docdash/",
"encoding": "utf8",
"destination": "jsdocs/",
"recurse": true,
"verbose": true,
"access": "public"
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"default": {
"useLongnameInNav": true
}
},
"openGraph": {
"title": "UI5 Tooling - API Reference",
"type": "website",
"image": "https://sap.github.io/ui5-tooling/docs/images/UI5_logo_wide.png",
"site_name": "UI5 Tooling - API Reference",
"url": "https://sap.github.io/ui5-tooling/"
},
"docdash": {
"sectionOrder": [
"Modules",
"Namespaces",
"Classes",
"Externals",
"Events",
"Mixins",
"Tutorials",
"Interfaces"
],
"meta": {
"title": "UI5 Tooling - API Reference - UI5 Project",
"description": "UI5 Tooling - API Reference - UI5 Project",
"keyword": "openui5 sapui5 ui5 build development tool api reference"
},
"search": true,
"wrap": true,
"menu": {
"GitHub": {
"href": "https://github.com/SAP/ui5-project",
"target": "_blank",
"class": "menu-item",
"id": "github_link"
}
}
}
}