Skip to content

API Extractor support for Firestore Exp and Lite #4095

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.

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

Merged
merged 32 commits into from
Nov 25, 2020
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
1e359b5
Script to Prune .dts files (with tests)
schmidt-sebastian Nov 19, 2020
8a081c3
Merge branch 'master' into mrschmidt/standalonescript
schmidt-sebastian Nov 19, 2020
f3f24da
API Extractor for Firestore
schmidt-sebastian Nov 19, 2020
1cb26d3
Add API Reports
schmidt-sebastian Nov 20, 2020
a782916
Ignore missing release and @Hideconstructor warning
schmidt-sebastian Nov 20, 2020
db711f5
s/return/returns
schmidt-sebastian Nov 20, 2020
8161362
Add Hyphen
schmidt-sebastian Nov 20, 2020
c1ac88d
Update API Extractor configuration
schmidt-sebastian Nov 20, 2020
6ba806e
Add Lite configuration
schmidt-sebastian Nov 20, 2020
0b6a18e
Lint fix
schmidt-sebastian Nov 20, 2020
299d267
Fix parenthesis
schmidt-sebastian Nov 20, 2020
1f2ac1f
HTML escape
schmidt-sebastian Nov 20, 2020
6d5b216
Ignore ae-unresolved-link
schmidt-sebastian Nov 20, 2020
ef6d871
Add ESLint type
schmidt-sebastian Nov 20, 2020
dbfaba7
yarn.lock
schmidt-sebastian Nov 20, 2020
c28b5f2
Misc fixes
schmidt-sebastian Nov 20, 2020
fcd5d3c
Move to /repo-scripts
schmidt-sebastian Nov 20, 2020
f4d4952
Update package.json
schmidt-sebastian Nov 20, 2020
9a286f4
Add TODO/test
schmidt-sebastian Nov 20, 2020
d7909d5
Update yarn.lock
schmidt-sebastian Nov 21, 2020
3f8bbf2
Fix JSON
schmidt-sebastian Nov 21, 2020
821a6da
Merge
schmidt-sebastian Nov 24, 2020
873b9ea
Merge
schmidt-sebastian Nov 24, 2020
d98ca33
Merge branch 'master' into mrschmidt/standalonescript
schmidt-sebastian Nov 24, 2020
6eaa0ac
Merge
schmidt-sebastian Nov 24, 2020
4911012
Cleanup
schmidt-sebastian Nov 24, 2020
c1d89d0
WIP
schmidt-sebastian Nov 24, 2020
3c2dd19
Fix yarn.lock
schmidt-sebastian Nov 24, 2020
d94c544
Merge branch 'mrschmidt/standalonescript' into mrschmidt/apiextract
schmidt-sebastian Nov 24, 2020
89a574b
Update package.json
schmidt-sebastian Nov 24, 2020
5fa16b2
Merge
schmidt-sebastian Nov 25, 2020
decc324
Prettier/Cleanup
schmidt-sebastian Nov 25, 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
551 changes: 551 additions & 0 deletions common/api-review/firestore-exp.api.md

Large diffs are not rendered by default.

454 changes: 454 additions & 0 deletions common/api-review/firestore-lite.api.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
"@types/chai-as-promised": "7.1.3",
"@types/child-process-promise": "2.2.1",
"@types/clone": "2.1.0",
"@types/eslint": "7.2.5",
"@types/inquirer": "7.3.1",
"@types/listr": "0.14.2",
"@types/long": "4.0.1",
Expand Down
9 changes: 9 additions & 0 deletions packages/firestore/.eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@ module.exports = {
]
},
overrides: [
{
files: ['**/*.d.ts'],
rules: {
'camelcase': 'off',
'import/no-duplicates': 'off',
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-unused-vars': 'off'
}
},
{
files: ['**/*.test.ts', '**/test/**/*.ts'],
rules: {
Expand Down
23 changes: 23 additions & 0 deletions packages/firestore/exp/api-extractor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"extends": "../../../config/api-extractor.json",
"mainEntryPointFilePath": "../dist/firestore/exp/index.d.ts",
"dtsRollup": {
"enabled": true,
"publicTrimmedFilePath": "../dist/exp/private.d.ts"
},
"messages": {
"extractorMessageReporting": {
"ae-missing-release-tag": {
"logLevel": "none"
},
"ae-unresolved-link": {
"logLevel": "none"
}
},
"tsdocMessageReporting": {
"tsdoc-undefined-tag": {
"logLevel": "none"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you not want to get warned about APIs that don't have documentation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This hides the warning for @hideconstructor.

}
}
}
}
4 changes: 2 additions & 2 deletions packages/firestore/exp/package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "@firebase/firestore/exp",
"name": "@firebase/firestore-exp",
"description": "A tree-shakeable version of the Firestore SDK",
"main": "../dist/exp/index.node.umd.js",
"main-esm": "../dist/exp/index.node.esm2017.js",
"module": "../dist/exp/index.browser.esm2017.js",
"browser": "../dist/exp/index.browser.esm2017.js",
"react-native": "../dist/exp/index.rn.esm2017.js",
"typings": "../exp-types/index.d.ts",
"typings": "../dist/exp/index.d.ts",
"private": true
}
2 changes: 1 addition & 1 deletion packages/firestore/exp/src/api/database.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export interface Settings extends LiteSettings {
/**
* The Cloud Firestore service interface.
*
* Do not call this constructor directly. Instead, use {@link getFirestore()}.
* Do not call this constructor directly. Instead, use {@link getFirestore}.
*/
export class FirebaseFirestore extends LiteFirestore {
readonly _queue = new AsyncQueue();
Expand Down
4 changes: 2 additions & 2 deletions packages/firestore/externs.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
"packages-exp/app-exp/dist/app-exp.d.ts",
"packages-exp/app-types-exp/index.d.ts",
"packages/auth-interop-types/index.d.ts",
"packages/firestore/exp-types/index.d.ts",
"packages/firestore/lite-types/index.d.ts",
"packages/firestore/dist/lite/index.d.ts",
"packages/firestore/dist/exp/index.d.ts",
"packages/firestore-types/index.d.ts",
"packages/firebase/index.d.ts",
"packages/component/dist/src/component.d.ts",
Expand Down
Loading