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.

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

Command to list experimental/unstable API #15754

Closed
oandregal opened this issue May 21, 2019 · 4 comments
Closed

Command to list experimental/unstable API #15754

oandregal opened this issue May 21, 2019 · 4 comments
Labels
[Type] Code Quality Issues or PRs that relate to code quality [Type] Developer Documentation Documentation for developers

Comments

@oandregal
Copy link
Member

oandregal commented May 21, 2019

As discussed in today's core-js meeting -slack conversation (requires registration), link to notes (pending)-, we want to keep track of the existing unstable and experimental APIs and when they were added.

This should help with the next steps: figure out how to remove them or make them stable.

@oandregal oandregal self-assigned this May 21, 2019
@gziolo gziolo added [Type] Developer Documentation Documentation for developers [Type] Code Quality Issues or PRs that relate to code quality labels May 23, 2019
@gziolo
Copy link
Member

gziolo commented Oct 20, 2019

@nosolosw, any progress on it? We want to audit those APIs with #17743.

@oandregal
Copy link
Member Author

Unfortunately, no: my focus has changed since and I didn't have the time to tackle this. Please, feel free to close, reassign, etc.

@oandregal oandregal removed their assignment Oct 21, 2019
@oandregal
Copy link
Member Author

For what is worth, this is what I was thinking: we could use docgen to extract the existing export definitions, and then write a script that work with those. Something along the lines of:

npx docgen packages/viewport/src/index.js --debug

Note the --debug in the command. That outputs a file ending in -ir.json (ir for intermediate representation) that contains all exports with names, etc. In the example above, we'd get:

[
	{
		"path": "packages/viewport/src/index.js",
		"name": "ifViewportMatches",
		"description": "...",
		"tags": [ ... ],
		"lineStart": 7,
		"lineEnd": 7
	},
...
]

The name exported is there under the name key so we could write a script that uses these files to look for unstable/experimental suffixes/prefixes.

@oandregal
Copy link
Member Author

Closing it, as it seems no longer needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Code Quality Issues or PRs that relate to code quality [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

2 participants