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

chore(v2): improve a11y & tweak eslint #1445

Merged
merged 1 commit into from
May 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 7 additions & 3 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ module.exports = {
rules: {
'class-methods-use-this': OFF, // It's a way of allowing private variables.
'func-names': OFF,
'import/no-unresolved': WARNING, // Because it couldn't resolve webpack alias.
// Ignore certain webpack alias because it can't be resolved
'import/no-unresolved': [
ERROR,
{ignore: ['^@theme', '^@docusaurus', '^@generated']},
],
'header/header': [
ERROR,
'block',
Expand All @@ -42,8 +46,8 @@ module.exports = {
' ',
],
],
'jsx-a11y/click-events-have-key-events': OFF, // Revisit in future™
'jsx-a11y/no-noninteractive-element-interactions': OFF, // Revisit in future™
'jsx-a11y/click-events-have-key-events': WARNING,
'jsx-a11y/no-noninteractive-element-interactions': WARNING,
'no-console': OFF,
'no-underscore-dangle': OFF,
'react/jsx-closing-bracket-location': OFF, // Conflicts with Prettier.
Expand Down
8 changes: 4 additions & 4 deletions packages/docusaurus/src/client/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
import React from 'react';
import {renderRoutes} from 'react-router-config';

import Head from '@docusaurus/Head'; // eslint-disable-line
import routes from '@generated/routes'; // eslint-disable-line
import siteConfig from '@generated/docusaurus.config'; //eslint-disable-line
import DocusaurusContext from '@docusaurus/context'; // eslint-disable-line
import Head from '@docusaurus/Head';
import routes from '@generated/routes';
import siteConfig from '@generated/docusaurus.config';
import DocusaurusContext from '@docusaurus/context';
import PendingNavigation from './PendingNavigation';

function App() {
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus/src/client/clientEntry.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ import React from 'react';
import {hydrate, render} from 'react-dom';
import {BrowserRouter} from 'react-router-dom';

import routes from '@generated/routes';
import App from './App';
import preload from './preload';
import docusaurus from './docusaurus';
import routes from '@generated/routes'; // eslint-disable-line

// Client-side render (e.g: running in browser) to become single-page application (SPA).
if (typeof window !== 'undefined' && typeof document !== 'undefined') {
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus/src/client/docusaurus.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/
import {matchRoutes} from 'react-router-config';
import routesChunkNames from '@generated/routesChunkNames';
import routes from '@generated/routes'; // eslint-disable-line
import routes from '@generated/routes';
import prefetchHelper from './prefetch';
import preloadHelper from './preload';
import flat from './flat';
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus/src/client/serverEntry.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import Loadable from 'react-loadable';

import path from 'path';
import fs from 'fs';
import routes from '@generated/routes'; // eslint-disable-line
import routes from '@generated/routes';
import preload from './preload';
import App from './App';
import ssrTemplate from './templates/ssr.html.template';
Expand Down
4 changes: 2 additions & 2 deletions packages/docusaurus/src/client/theme-fallback/Layout/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
*/

import React from 'react';
import Head from '@docusaurus/Head'; // eslint-disable-line
import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; // eslint-disable-line
import Head from '@docusaurus/Head';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';

function Layout(props) {
const context = useDocusaurusContext();
Expand Down
5 changes: 5 additions & 0 deletions website/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ function Home() {
<div className="col">
<img
className={styles.featureImage}
alt={'Powered by Markdown'}
src={`${siteConfig.baseUrl}img/undraw_typewriter.svg`}
/>
<h3>Powered by Markdown</h3>
Expand All @@ -136,6 +137,7 @@ function Home() {
</div>
<div className="col">
<img
alt={'Built Using React'}
className={styles.featureImage}
src={`${siteConfig.baseUrl}img/undraw_react.svg`}
/>
Expand All @@ -148,6 +150,7 @@ function Home() {
</div>
<div className="col">
<img
alt={'Ready for Translations'}
className={styles.featureImage}
src={`${siteConfig.baseUrl}img/undraw_around_the_world.svg`}
/>
Expand All @@ -163,6 +166,7 @@ function Home() {
<div className="row">
<div className="col col--4 col--offset-2">
<img
alt={'Document Versioning'}
className={styles.featureImage}
src={`${siteConfig.baseUrl}img/undraw_version_control.svg`}
/>
Expand All @@ -175,6 +179,7 @@ function Home() {
</div>
<div className="col col--4">
<img
alt={'Document Search'}
className={styles.featureImage}
src={`${siteConfig.baseUrl}img/undraw_algolia.svg`}
/>
Expand Down