Skip to content

docs: add step with example selector for new language #106

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

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

Conversation

amareshsm
Copy link
Member

…rySelectorPlaceholder

Prerequisites checklist

What is the purpose of this pull request?

What changes did you make? (Give an overview)

update docs to ensure it's up-to-date with all of the required steps

Related Issues

Is there anything you'd like reviewers to focus on?

Copy link

netlify bot commented May 15, 2025

Deploy Preview for eslint-code-explorer ready!

Name Link
🔨 Latest commit 2bd479c
🔍 Latest deploy log https://app.netlify.com/projects/eslint-code-explorer/deploys/6825809b6e583400085d5829
😎 Deploy Preview https://deploy-preview-106--eslint-code-explorer.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@lumirlumir lumirlumir changed the title chore: add step to include example selector for new language in esque… docs: add step with example selector for new language in esquerySelectorPlaceholder May 15, 2025
@lumirlumir lumirlumir changed the title docs: add step with example selector for new language in esquerySelectorPlaceholder docs: add step with example selector for new language May 15, 2025
@eslint-github-bot eslint-github-bot bot added the documentation Improvements or additions to documentation label May 15, 2025
@eslint eslint deleted a comment from eslint-github-bot bot May 15, 2025
@lumirlumir lumirlumir added the accepted There is consensus among the team that this change meets the criteria for inclusion label May 15, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage May 15, 2025
@amareshsm amareshsm requested a review from lumirlumir May 15, 2025 08:54
@lumirlumir lumirlumir moved this from Needs Triage to Second Review Needed in Triage May 15, 2025
Copy link
Member

@lumirlumir lumirlumir left a comment

Choose a reason for hiding this comment

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

LGTM, Thanks!

Would like one more review before merging.

@@ -23,6 +23,7 @@ Add an SVG logo into the `public/languages/` directory.
1. Default the default code for the new language (such as `defaultJsonCode` or `defaultCssCode`).
1. Add an entry in the `defaultCode` variable for the new language's default code.
1. Export a variable containing the default options for the new language (such as `defaultJsonOptions` or `defaultCssOptions`).
1. Add an entry to the `esquerySelectorPlaceholder` constant for the new language, using an appropriate example selector.
Copy link
Member

Choose a reason for hiding this comment

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

It would be great if we could actually link to where exactly this is in code? That would be better for someone newly exploring the repo? WDYT

@nzakas
Copy link
Member

nzakas commented May 15, 2025

Just to double-check, are the rest of the steps still accurate?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion chore documentation Improvements or additions to documentation
Projects
Status: Second Review Needed
Development

Successfully merging this pull request may close these issues.

4 participants