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

Add --init-emojis option to suggest emojis for configs #432

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bmish
Copy link
Owner

@bmish bmish commented Mar 17, 2023

This new option --init-emojis uses gpt-emoji (which queries OpenAI for a suggestion on what emoji to use to represent the given text) to suggest an emoji to represent each of the user's configs.

For example, with a config name statements, the AI may suggest "🗣️" as the emoji to represent it.

This is useful especially when a user has one or more obscure config names, and needs to pick a unique emoji to represent each for good documentation understandability and aesthetics.

Related: #394

TODO:

Sample output with eslint-plugin-import:

eslint-doc-generator --init-emojis
╔══════════════╤═══════╗
║ Config       │ Emoji ║
╟──────────────┼───────╢
║ recommended  │ 👍    ║
╟──────────────┼───────╢
║ errors       │ ❗️   ║
╟──────────────┼───────╢
║ warnings     │ ⚠️    ║
╟──────────────┼───────╢
║ stage-0      │ 0️    ║
╟──────────────┼───────╢
║ react        │ ⚛️    ║
╟──────────────┼───────╢
║ react-native │ 📱    ║
╟──────────────┼───────╢
║ electron     │ 💻    ║
╟──────────────┼───────╢
║ typescript   │ 🆕️   ║
╚══════════════╧═══════╝

@bmish bmish added the enhancement New feature or request label Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant