Skip to content

Commit cb42dce

Browse files
iclantoniclanton
committed
Initial creation of @rushstack/typings-generator package.
1 parent 15f7963 commit cb42dce

File tree

12 files changed

+148
-7
lines changed

12 files changed

+148
-7
lines changed

‎common/config/rush/nonbrowser-approved-packages.json

+4
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,10 @@
170170
"name": "@rushstack/localization-plugin",
171171
"allowedCategories": [ "tests" ]
172172
},
173+
{
174+
"name": "@rushstack/typings-generator",
175+
"allowedCategories": [ "libraries" ]
176+
},
173177
{
174178
"name": "@typescript-eslint/eslint-plugin",
175179
"allowedCategories": [ "libraries" ]

‎common/config/rush/pnpm-lock.yaml

+19-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎libraries/typings-generator/.eslintrc.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// This is a workaround for https://github.com/eslint/eslint/issues/3458
2+
require("@rushstack/eslint-config/patch-eslint6");
3+
4+
module.exports = {
5+
extends: [ "@rushstack/eslint-config" ],
6+
parserOptions: { tsconfigRootDir: __dirname },
7+
};

‎libraries/typings-generator/.npmignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Ignore everything by default
2+
**
3+
4+
# Use negative patterns to bring back the specific things we want to publish
5+
!/bin/**
6+
!/lib/**
7+
!/dist/**
8+
!ThirdPartyNotice.txt
9+
10+
# Ignore certain files in the above folder
11+
/dist/*.stats.*
12+
/lib/**/test/*
13+
14+
# NOTE: These don't need to be specified, because NPM includes them automatically.
15+
#
16+
# package.json
17+
# README (and its variants)
18+
# CHANGELOG (and its variants)
19+
# LICENSE / LICENCE
20+
21+
## Project specific definitions
22+
# -----------------------------
23+
24+
# (Add your exceptions here)

‎libraries/typings-generator/LICENSE

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
@rushstack/typings-generator
2+
3+
Copyright (c) Microsoft Corporation. All rights reserved.
4+
5+
MIT License
6+
7+
Permission is hereby granted, free of charge, to any person obtaining
8+
a copy of this software and associated documentation files (the
9+
"Software"), to deal in the Software without restriction, including
10+
without limitation the rights to use, copy, modify, merge, publish,
11+
distribute, sublicense, and/or sell copies of the Software, and to
12+
permit persons to whom the Software is furnished to do so, subject to
13+
the following conditions:
14+
15+
The above copyright notice and this permission notice shall be
16+
included in all copies or substantial portions of the Software.
17+
18+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎libraries/typings-generator/config/api-extractor.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3+
4+
"mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
5+
6+
"apiReport": {
7+
"enabled": true,
8+
"reportFolder": "../../../common/reviews/api"
9+
},
10+
11+
"docModel": {
12+
"enabled": true,
13+
"apiJsonFilePath": "../../../common/temp/api/<unscopedPackageName>.api.json"
14+
},
15+
16+
"dtsRollup": {
17+
"enabled": true
18+
}
19+
}

‎libraries/typings-generator/gulpfile.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
'use strict';
2+
3+
const build = require('@microsoft/node-library-build');
4+
5+
build.initialize(require('gulp'));

‎libraries/typings-generator/package.json

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "@rushstack/typings-generator",
3+
"version": "0.0.0",
4+
"description": "This library provides functionality for automatically generator typings for non-TS files.",
5+
"main": "lib/index.js",
6+
"typings": "dist/typings-generator.d.ts",
7+
"tsdoc": {
8+
"tsdocFlavor": "AEDoc"
9+
},
10+
"license": "MIT",
11+
"repository": {
12+
"type": "git",
13+
"url": "https://github.com/Microsoft/rushstack/tree/master/libraries/typings-generator"
14+
},
15+
"scripts": {
16+
"build": "gulp test --clean"
17+
},
18+
"dependencies": {
19+
"@types/node": "10.17.13",
20+
"glob": "~7.0.5",
21+
"@microsoft/node-core-library": "3.19.3",
22+
"chokidar": "~3.3.1"
23+
},
24+
"devDependencies": {
25+
"@microsoft/rush-stack-compiler-3.5": "0.4.3",
26+
"@microsoft/node-library-build": "6.4.4",
27+
"@rushstack/eslint-config": "0.5.4",
28+
"@types/glob": "7.1.1",
29+
"gulp": "~4.0.2"
30+
}
31+
}

‎libraries/typings-generator/src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
2+
// See LICENSE in the project root for license information.

‎libraries/typings-generator/tsconfig.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": "./node_modules/@microsoft/rush-stack-compiler-3.5/includes/tsconfig-node.json"
3+
}

‎rush.json

+8-2
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@
655655
"packageName": "@microsoft/node-core-library",
656656
"projectFolder": "libraries/node-core-library",
657657
"reviewCategory": "libraries",
658-
"shouldPublish": true,
658+
"shouldPublish": true,
659659
"cyclicDependencyProjects": [
660660
"@microsoft/node-library-build",
661661
"@microsoft/rush-stack-compiler-3.5"
@@ -677,7 +677,7 @@
677677
"packageName": "@microsoft/stream-collator",
678678
"projectFolder": "libraries/stream-collator",
679679
"reviewCategory": "libraries",
680-
"shouldPublish": true
680+
"shouldPublish": true
681681
},
682682
{
683683
"packageName": "@microsoft/ts-command-line",
@@ -689,6 +689,12 @@
689689
"@microsoft/rush-stack-compiler-3.5"
690690
]
691691
},
692+
{
693+
"packageName": "@rushstack/typings-generator",
694+
"projectFolder": "libraries/typings-generator",
695+
"reviewCategory": "libraries",
696+
"shouldPublish": true
697+
},
692698

693699
// "repo-scripts" folder (alphabetical order)
694700
{

‎webpack/localization-plugin/package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,11 @@
2525
"dependencies": {
2626
"@types/node": "10.17.13",
2727
"@types/tapable": "1.0.4",
28+
"@microsoft/node-core-library": "3.19.3",
29+
"@rushstack/typings-generator": "0.0.0",
2830
"loader-utils": "~1.1.0",
2931
"glob": "~7.0.5",
3032
"jju": "~1.4.0",
31-
"@microsoft/node-core-library": "3.19.3",
3233
"lodash": "~4.17.15",
3334
"xmldoc": "~1.1.2",
3435
"chokidar": "~3.3.1",

0 commit comments

Comments
 (0)