forked from eslint/eslint.org
-
Notifications
You must be signed in to change notification settings - Fork 0
/
en.yml
599 lines (559 loc) · 24.3 KB
/
en.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
#------------------------------------------------------------------------------
# English Site Details
# The primary ESLint site that is hosted at eslint.org
# Author: Nicholas C. Zakas
#------------------------------------------------------------------------------
#------------------------------------------------------------------------------
# Global Settings
#------------------------------------------------------------------------------
language:
code: en
flag: 🇺🇸
name: English (US)
title: English (US)
locale: en-US
hostname: eslint.org
locals:
docs_latest: latest--docs-eslint.netlify.app
docs_head: docs-eslint.netlify.app
blog: true
redirects:
- from: https://cn.eslint.org/*
to: https://zh-hans.eslint.org
status: 301!
- from: https://docs.eslint.org/*
to: https://eslint.org/docs/latest/
status: 302!
#------------------------------------------------------------------------------
# Analytics
#------------------------------------------------------------------------------
google_analytics:
code: "G-7DGPHY308T"
#------------------------------------------------------------------------------
# Ads
#------------------------------------------------------------------------------
carbon_ads:
serve: CESDV2QM
placement: eslintorg
#------------------------------------------------------------------------------
# Shared
#------------------------------------------------------------------------------
shared:
get_started: Get Started
become_a_sponsor: Become a Sponsor
eslint_logo_alt: ESLint logo
description: >
A pluggable and configurable linter tool for identifying and reporting on
patterns in JavaScript. Maintain your code quality with ease.
title_format: PAGE_TITLE - ESLint - Pluggable JavaScript Linter
skip_to_content: Skip to main content
#------------------------------------------------------------------------------
# Navigation
#------------------------------------------------------------------------------
navigation:
- text: Team
link: team
- text: Blog
link: blog
- text: Docs
link: docs
- text: Store
link: store
target: _blank
- text: Playground
link: playground
target: _blank
#------------------------------------------------------------------------------
# Footer
#------------------------------------------------------------------------------
footer:
title: Ready to fix your JavaScript code?
description: Install from npm or start donating today.
secondary: Secondary
social_icons:
title: Social Media
twitter: Twitter
chat: Discord
mailing_list: Google Group
github: GitHub
mastodon: Mastodon
theme_switcher:
title: Theme Switcher
light: Light
dark: Dark
language_switcher:
title: Language Switcher
description: Selecting a language will take you to the ESLint website in that language.
change_language: Change Language
language: Language
copyright: >
Copyright <a href="https://openjsf.org">OpenJS Foundation</a> and ESLint
contributors. All rights reserved. The <a href="https://openjsf.org">OpenJS
Foundation</a> has registered trademarks and uses trademarks. For a list of
trademarks of the <a href="https://openjsf.org">OpenJS Foundation</a>, please
see our <a href="https://trademark-policy.openjsf.org">Trademark Policy</a>
and <a href="https://trademark-list.openjsf.org">Trademark List</a>.
Trademarks and logos not indicated on the
<a href="https://trademark-list.openjsf.org">list of OpenJS Foundation
trademarks</a> are trademarks™ or registered® trademarks of
their respective holders. Use of them does not imply any affiliation with
or endorsement by them.
links:
open_jsf: The OpenJS Foundation
terms: Terms of Use
privacy: Privacy Policy
bylaws: OpenJS Foundation Bylaws
trademark: Trademark Policy
trademark_list: Trademark List
cookies: Cookie Policy
#------------------------------------------------------------------------------
# 404 Page
#------------------------------------------------------------------------------
404_page:
title: 404 error
subtitle: Page not found
description: Sorry, the page you are looking for doesn't exist or has been moved.
actions:
back_to_home: Back to homepage
browse_docs: Browse the docs
#------------------------------------------------------------------------------
# Branding Page
#------------------------------------------------------------------------------
branding_page:
title: Branding
description: How to use our logo
sections:
name:
title: Name
description: >
ESLint must be written with a capital E, S and L when used, as “ES” stands
for ECMAScript and “L” being the start of the word “Lint”.
logo:
title: Logo
description:
- >
The ESLint logo can be placed on various backgrounds, provided it has
enough vertical and horizontal padding.
- >
Double the size of the inner hexagon created by the gap to get an idea
how much space the logo should have between the logo and wordmark, as
well as around the logo itself.
- >
Our logo is versatile - you can use it on various brand colours, making
use of opacity on non-white backgrounds to emulate the lighter colour.
The ESLint logomark can also be used in isolation, without the ESLint
wordmark though where possible, using both is preferred.
download_svg: Download SVG
download_png: Download PNG
change_background: "Change Background:"
color_palette:
title: Color Palette
description:
- >
ESLint’s colour palette can speak to our brand in ways that are every
bit as powerful as copy and logos. They not only affect how our design
looks, but can go as far as to elicit emotion and reflect the
personality of the ESLint brand.
- >
The primary "brand" color is used across all interactive elements such
as buttons, links, inputs, etc. It is derived from our logo. We use the
two existing colors to create a unique primary tonal range.
brand_palette: Brand Palette
colors:
primary: Primary
white: White
neutral: Neutral
actions:
back_to_home: Back to homepage
browse_docs: Browse the docs
#------------------------------------------------------------------------------
# Homepage
#------------------------------------------------------------------------------
homepage:
title: Find and fix problems in your JavaScript code
description: >
ESLint statically analyzes your code to quickly find problems. It is built
into most text editors and you can run ESLint as part of your continuous
integration pipeline.
animation:
enabled: true
text: Find and fix problems in your JavaScript code
highlight_word: problems
wrong_word: problmes
install:
title: ESLint quick install code
copy: Copy installation code to clipboard
copied: Copied to clipboard.
versions:
title: ESLint Versions
latest: Latest Version
upcoming: Upcoming Version
development: Development
dateline: <span class="text-dark">VERSION</span> on DATE
explainer:
image:
src: eslint-features-img.png
alt: "Screenshot of a Visual Studio code window with ESLint in action: underlining ESLint error in the editor."
title: The pluggable linting utility for JavaScript and JSX
description: >
ESLint is an open source project that helps you find and fix problems
with your JavaScript code. It doesn't matter if you're writing JavaScript in
the browser or on the server, with or without a framework, ESLint can help
your code live its best life.
features:
- title: Find issues
description: >
ESLint statically analyzes your code to quickly find problems. ESLint is
built into most text editors and you can run ESLint as part of your
continuous integration pipeline.
learn_more:
link: getStarted
text: >
Learn more <span class="visually-hidden">about finding issues with ESLint</span>
- title: Fix problems automatically
description: >
Many problems ESLint finds can be automatically fixed. ESLint fixes are
syntax-aware so you won't experience errors introduced by traditional
find-and-replace algorithms.
learn_more:
link: fixProblems
text: >
Learn more <span class="visually-hidden">about fixing problems automatically with ESLint</span>
- title: Configure everything
description: >
Preprocess code, use custom parsers, and write your own rules that work
alongside ESLint's built-in rules. Customize ESLint to work exactly the
way you need it for your project.
learn_more:
link: configuring
text: >
Learn more <span class="visually-hidden">about configuring ESLint</span>
blog:
view_all_posts: View all posts
stats:
title: Welcome to the community
description: >
ESLint is the #1 JavaScript linter by downloads on npm (over DOWNLOAD_COUNT
downloads / week) and is used at companies like Microsoft, Airbnb, Netflix,
and Facebook.
dependents: Dependents
weekly_downloads: Weekly Downloads
stars: Stars
sponsors:
title: Sponsored by fantastic people
description: >
We receive ANNUAL_DONATIONS / year in donations from SPONSOR_COUNT sponsors.
view_all_sponsors: View all sponsors
donations:
title: Recent One-time Donations
view_all_donations: View all donations
#------------------------------------------------------------------------------
# Blog Page
#------------------------------------------------------------------------------
blog_page:
title: News and Updates
description: The latest ESLint news, case studies, tutorials, and resources.
search:
title: Search
hint: Results will be shown and updated as you type.
clear: Clear Search
categories:
title: Categories
everything: Everything
pagination:
title: Pagination
first_page: First
next_page: Next
previous_page: Previous
last_page: Last
status: Page PAGE_NUMBER of TOTAL_PAGE_COUNT
from_the_blog: From the blog
#------------------------------------------------------------------------------
# Team Page
#------------------------------------------------------------------------------
team_page:
title: Meet our Team
description: >
These are the people who build and maintain ESLint.
tsc:
title: Technical Steering Committee
description: >
The people who manage releases, review feature requests, and meet
regularly to ensure ESLint is properly maintained.
reviewers:
title: Reviewers
description: >
The people who review and implement new features.
committers:
title: Committers
description: >
The people who review and fix bugs and help triage issues.
website_team:
title: Website Team
description: >
Team members who focus specifically on eslint.org
support_team:
title: Support Team
description: >
Folks who help in Discord, discussions, and the mailing list.
alumni:
title: Alumni
description: >
Former team members who previously helped maintain ESLint.
#------------------------------------------------------------------------------
# Sponsors Page
#------------------------------------------------------------------------------
sponsors_page:
title: Sponsors
description: >
BACKER_COUNT companies, organizations, and individuals are currently
contributing MONTHLY_DONATIONS each month to support ESLint's ongoing
maintenance and development.
hero:
cta:
text: Become a Sponsor
url: /donate
tiers:
platinum:
title: Platinum Sponsors
description: >
Become a platinum sponsor with a monthly donation of $2000 USD (providing
40 hours of maintenance and development) and get 2 hours of dedicated
support (remote support available through chat or screen-sharing) per
month as well as your Open Collective or GitHub avatar image on our
README on GitHub and on the home page of eslint.org. We will also
tweet a thank you from our Twitter account (over 20,000 followers).
Please contact the ESLint team to schedule support sessions.
gold:
title: Gold Sponsors
description: >
Become a gold sponsor with a monthly donation of $1000 USD (providing 20
hours of maintenance and development) and get your Open Collective
or GitHub avatar image on our README on GitHub and the front page of
eslint.org. We will also tweet a thank you from our Twitter account
(over 20,000 followers).
silver:
title: Silver Sponsors
description: >
Become a silver sponsor with a monthly donation of $500 USD (providing 10
hours of maintenance and development) and get your Open Collective
or GitHub avatar image on our README on GitHub and the front page
of eslint.org.
bronze:
title: Bronze Sponsors
description: >
Become a bronze sponsor with a monthly donation of $200 USD (providing four
hours of maintenance and development) and get your Open Collective
or GitHub avatar image on our README on GitHub and the front page of
eslint.org.
technology:
title: Technology Sponsors
description: >
Technology sponsors allow us to use their products and services for
free as part of a contribution to the open source ecosystem and our work.
backers:
title: All backers
description: >
Backers provide monthly contributions to help maintain ESLint.
recent_donations:
title: Recent one-time donations
description: >
We also receive a lot of one-time contributions from fantastic people.
Here are some recent ones from OpenCollective and GitHub.
sponsor_title: SPONSOR_NAME is donating AMOUNT each month
tech_sponsor_title: TECH provided by SPONSOR_NAME
#------------------------------------------------------------------------------
# Donate Page
#------------------------------------------------------------------------------
donate_page:
title: Donate
description: >
ESLint relies on donations for ongoing maintenance and development.
There are currently BACKER_COUNT companies, organizations, and individuals
donating MONTHLY_DONATIONS each month to help us out.
hero:
cta:
text: See our Sponsors
url: /sponsors
donation_options:
title: Ways to donate
subtitle: We accept donations through the following sites.
open_collective:
title: Open Collective
subtitle: Our most popular plan for companies.
cta:
text: Contribute on Open Collective
items:
- text: Donate directly to a 501(c)(6) non-profit
- text: One-time and recurring donations
- text: Pay by credit card, bank transfer, or PayPal
- text: Set up an open source fund to donate to multiple projects
- text: Available in most countries
github_sponsors:
title: GitHub Sponsors
subtitle: Advanced features and reporting.
cta:
text: Contribute on GitHub
items:
- text: Donate through GitHub billing
- text: One-time and recurring donations
- text: Pay by credit card or use your existing billing relationship with GitHub (including invoicing)
- text: Show a “sponsor” badge on your GitHub profile
- text: Use your existing GitHub login
budget:
title: How the money is used
subtitle: >
The ESLint project uses donated money to benefit the project and the ESLint community as a whole.
In general, we spend money on these areas each month.
items:
- name: Team Development
text: >
We pay our team members an hourly rate based on their seniority, currently HOURLY_RATE_TSC USD/hour
for TSC members and Reviewers and HOURLY_RATE_COMMITERS USD/hour for committers.
- name: Contributor Pool
text: >
We set aside CONTRIBUTOR_POOL_BUDGET USD each month to pay outside contributors who have made significant
contributions to the project. Contributions include submitting code, writing documentation,
answering questions in our Discord server, and more. This money is allocated each month by the TSC.
- name: Dependencies
text: >
We set aside DEPENDENCIES_BUDGET USD each month to help support our dependencies.
We believe that open source projects who are lucky enough to get funded
have a responsibility to help support the smaller projects they rely on.
- name: Community Projects
text: >
We set aside COMMUNITY_BUDGET USD each month to help support plugins, parsers,
and other projects that are of benefit to the ESLint ecosystem as a whole.
We believe the strength of the project is in its ecosystem and we want
to ensure important projects remain well-maintained.
- name: Support Systems
text: >
We use a small amount each month to pay for software the team uses to help manage
the project, which includes things like Google Workspace and cloud storage.
footer:
text: >
Additionally, from time to time we use the funds to pay contractors to work on things
that are important to the project and where the team doesn’t have the time or expertise
to complete the work on their own. For example, we recently hired a designer and developer
to redesign this website. We ensure that we spend less than we take in each month so we
can save for such projects.
donation_tiers:
title: Donation tiers
subtitle: While we accept donations of any size, we do have a tier system with different rewards at each level.
cta:
open_collective_text: >
Donate <span class="visually-hidden">on Open Collective</span>
github_sponsors_text: >
Donate <span class="visually-hidden">on GitHub</span>
items:
- name: Platinum Sponsor
amount: $2000+
frequency: per month
text: 2 hours of support, highest logo placement on homepage and readme and everything in Gold tier.
- name: Gold Sponsor
amount: $1000–1999
frequency: per month
text: Second highest logo placement on homepage and readme, a Thank you tweet from our Twitter account (20,000 followers) and a thank you blog post.
- name: Silver Sponsor
amount: $500–999
frequency: per month
text: Third highest logo placement on homepage and readme.
- name: Bronze Sponsor
amount: $200–499
frequency: per month
text: Fourth highest logo placement on homepage and readme.
testimonials:
title: testimonials
items:
- name: Addy Osmani
title: Senior Staff Eng. Manager, Chrome
image: addy-osmani.jpg
text: >
ESLint has been critical in helping developers write high-quality JavaScript
for years. We love that it catches common issues early and often. With a high
level of extensibility, ESLint's ability to let teams enforce custom rules that
work for them has been excellent for open-source projects and more. Chrome is
happy to sponsor ESLint to help web developers write consistently high-quality
code. It's an essential piece of the modern web development toolkit.
- name: Jeff Cross
title: Co-founder and Principal Architect, Nx
image: jeff-cross.jpg
text: >
Nx uses ESLint to enforce code quality, library boundaries, and project visibility
constraints. ESLint makes Nx more powerful, so on behalf of the Nx.dev community,
we're proud to do our part and sponsor ESLint's continued success!
- name: Médédé Raymond KPATCHAA
title: Technical Architect, Salesforce
image: medede-kpatchaa.jpg
text: >
ESLint is an extremely useful tool for any JavaScript project. This tool allows
us to set up consistent code formatting rules adopted by the whole team from the
beginning of the project, greatly facilitates code reviews, and makes it easy
to integrate new developers into the team. I know I am not alone in appreciating
its flexibility and ease-of-use.
- name: Duane O'Brien
title: Head of Open Source, Indeed
image: duane-obrien.jpg
text: >
Most JavaScript projects directly or transitively depend on ESLint. An Indeed
employee nominated ESLint to receive a donation from the FOSS Contributor Fund,
and their colleagues clearly agreed. We're happy to support the open source technologies
that allow us to develop, protect, and maintain the digital infrastructure that
supports our products and helps people get jobs.
- name: Gajus Kuizinas
title: Co-Founder / CTO, Contra
image: gajus.jpg
text: >
ESLint plays a major role in helping us create a safe and consistent experience
across a growing number of codebases and engineers. We are grateful for all the
open-source projects that are helping us build Contra, and ESLint is the first
of many open-source projects that we are committed to back.
faq:
title: Frequently Asked Questions
description: Everything you need to know about the product and billing. Can’t find the answer you’re looking for? Please chat to our friendly team.
items:
- q: Who receives the money that is donated?
a: All contributions, whether donated through <a href='https://opencollective.com'>Open
Collective</a> or GitHub, are received by the Open Source Collective, which is
a 501(c)(6) non-profit organization. The Open Source Collective acts as a fiscal
host for ESLint and keeps track of all donations.
- q: Will I get a record of my donations?
a: Yes. If you donate through Open Collective, you will receive a PDF receipt via
email; if you donate through GitHub, the donation will appear on your receipt
or invoice.
- q: Is my donation tax deductible?
a: No. Even though the Open Source Collective is a 501(c)(6) non-profit organization,
the IRS doesn't consider development of open source software to be a charitable
activity and therefore doesn’t grant tax-exempt status.
- q: Who decides how the money is distributed?
a: The TSC makes all decisions regarding who receives the money and how much is
distributed.
- q: Can I see how the money is being used?
a: Yes. By going to our Open Collective page, you can see every expense that has
been submitted and paid. All transactions are completely open and publicly visible.
- q: Can I cancel my recurring donation at any time?
a: Yes. There is no long-term commitment. You can cancel your donation at any time
by logging into either Open Collective or GitHub sponsors.
- q: How long does it take for my logo to appear on the homepage, GitHub, and npm
package?
a: The logos on the homepage and GitHub are automatically updated every day so it
should take no longer than 24 hours to appear. The logos on the npm package are
only updated when we publish a new release, which is typically every two weeks.
However, major releases often take several months to complete and during that
time logos on the npm package will not be updated.
- q: Where do my logo and URL come from?
a: We pull the logo and URL from your Open Collective or GitHub profiles, depending
on which site you used to donate. You can update these at any time from within
Open Collective or GitHub and those changes will be reflected on the homepage
and GitHub README within 24 hours. We aren't able to manually override logos or
URLs on the site.
- q: Is it possible to make a one-time donation?
a: Yes. The easiest way to make a one-time donation is through Open Collective,
which allows any amount. GitHub one-time donations may have a limit on the amount
you can donate.
#------------------------------------------------------------------------------
# Languages Page
#------------------------------------------------------------------------------
languages_page:
title: Languages
choose_language: Choose your language