goodcheck 2.5.0 → 2.7.0

data/docusaurus/docs/getstarted.md

@@ -1,46 +0,0 @@
----
-id: getstarted
-title: Getting Started
-sidebar_label: Get Started
----
-
-## Installation
-
-```bash
-$ gem install goodcheck
-```
-
-Or you can use `bundler`!
-
-If you would not like to install Goodcheck to system (e.g. you would not like to install Ruby 2.4 or higher), you can use a docker image. [See below](#docker-images).
-
-## Docker Images
-
-We provide Docker images of Goodcheck so that you can try Goodcheck without installing them.
-
-- https://hub.docker.com/r/sider/goodcheck/
-
-```bash
-$ docker pull sider/goodcheck
-$ docker run -t --rm -v "$(pwd):/work" sider/goodcheck check
-```
-
-The default `latest` tag points to the latest release of Goodcheck.
-You can pick a version of Goodcheck from [tags page](https://hub.docker.com/r/sider/goodcheck/tags).
-
-## Quickstart
-
-```bash
-$ goodcheck init
-$ vim goodcheck.yml
-$ goodcheck check
-```
-
-The `init` command generates a template of `goodcheck.yml` configuration file for you.
-Edit the config file to define patterns you want to check.
-Then run `check` command, and it will print matched texts.
-
-
-
-
-

data/docusaurus/docs/rules.md

@@ -1,79 +0,0 @@
----
-id: rules
-title: Rules
-sidebar_label: Rules
----
-
-
-## Rule: `"_blank"` Security Issue
-
-When `target = "_blank"` is used, the opened page can access the original window object and potentially redirect the original page to a malicious URL. In this example, the rule will look for patterns of `"_blank"` and suggest to use `rel="noopener"` to prevent the opened page from having access.
-
-```yaml
-rules:
-  - id: security.link
-    pattern:
-      - token: 'target="_blank"'
-      - token: 'target: "_blank"'
-    message: |
-      Specify rel="noopener" for security reasons.
-
-      Opening new tab without rel="noopener" may cause a security issue.
-      It allows modifying original tab URLs from opened tabs.
-    justification:
-      - When opening a URL in our service
-    glob:
-      - "**/*.html"
-      - "**/*.html.erb"
-    fail:
-      - '<a href="https://github.com" target="_blank">GitHub</a>'
-    pass:
-      - '<a href="/signup">Signup</a>'
-```
-
-## Rule: Sign in
-> Warning: This rule needs customization.
-
-Keep wording consistent to provide a clear experience for users. In this example, the use of Log in or Log out would prompt the use of sign in / sign out instead.
-
-```yaml
-rules:
-  - id: wording.signin
-    pattern:
-      - token: Log in
-        case_sensitive: false
-      - token: Log out
-        case_sensitive: false
-    glob:
-      - "**/*.html.erb"
-      - "**/*.yml"
-    message: |
-      Please use “sign in”/“sign out”
-
-      We use “sign in” instead of “log in” and “sign out” instead of “log out”.
-      See the wording policy for details.
-
-      https://docs.example.com/1840
-    fail:
-      - "Log in"
-      - "Log out"
-    pass:
-      - "Sign in"
-      - "Sign out"
-```
-
-## Rule: mixin
-> Warning: This rule needs customization.
-
-A mixin lets you make groups of CSS declarations that you want to reuse throughout your site. In this example, it creates a warning when the color pattern is used and suggests using a mixin instead.
-
-```yaml
-rules:
-  - id: use-mixin
-    message: Use mixin.
-    pattern: "color: #038cf4;"
-    pass:
-      - "@include some-mixin;"
-    fail:
-      - "color: #038cf4;"
-```

data/docusaurus/website/README.md

@@ -1,193 +0,0 @@
-This website was created with [Docusaurus](https://docusaurus.io/).
-
-# What's In This Document
-
-* [Get Started in 5 Minutes](#get-started-in-5-minutes)
-* [Directory Structure](#directory-structure)
-* [Editing Content](#editing-content)
-* [Adding Content](#adding-content)
-* [Full Documentation](#full-documentation)
-
-# Get Started in 5 Minutes
-
-1. Make sure all the dependencies for the website are installed:
-
-```sh
-# Install dependencies
-$ yarn
-```
-2. Run your dev server:
-
-```sh
-# Start the site
-$ yarn start
-```
-
-## Directory Structure
-
-Your project file structure should look something like this
-
-```
-my-docusaurus/
-  docs/
-    doc-1.md
-    doc-2.md
-    doc-3.md
-  website/
-    blog/
-      2016-3-11-oldest-post.md
-      2017-10-24-newest-post.md
-    core/
-    node_modules/
-    pages/
-    static/
-      css/
-      img/
-    package.json
-    sidebar.json
-    siteConfig.js
-```
-
-# Editing Content
-
-## Editing an existing docs page
-
-Edit docs by navigating to `docs/` and editing the corresponding document:
-
-`docs/doc-to-be-edited.md`
-
-```markdown
----
-id: page-needs-edit
-title: This Doc Needs To Be Edited
----
-
-Edit me...
-```
-
-For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Editing an existing blog post
-
-Edit blog posts by navigating to `website/blog` and editing the corresponding post:
-
-`website/blog/post-to-be-edited.md`
-```markdown
----
-id: post-needs-edit
-title: This Blog Post Needs To Be Edited
----
-
-Edit me...
-```
-
-For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
-
-# Adding Content
-
-## Adding a new docs page to an existing sidebar
-
-1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:
-
-```md
----
-id: newly-created-doc
-title: This Doc Needs To Be Edited
----
-
-My new content here..
-```
-
-1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:
-
-```javascript
-// Add newly-created-doc to the Getting Started category of docs
-{
-  "docs": {
-    "Getting Started": [
-      "quick-start",
-      "newly-created-doc" // new doc here
-    ],
-    ...
-  },
-  ...
-}
-```
-
-For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Adding a new blog post
-
-1. Make sure there is a header link to your blog in `website/siteConfig.js`:
-
-`website/siteConfig.js`
-```javascript
-headerLinks: [
-    ...
-    { blog: true, label: 'Blog' },
-    ...
-]
-```
-
-2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:
-
-`website/blog/2018-05-21-New-Blog-Post.md`
-
-```markdown
----
-author: Frank Li
-authorURL: https://twitter.com/foobarbaz
-authorFBID: 503283835
-title: New Blog Post
----
-
-Lorem Ipsum...
-```
-
-For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)
-
-## Adding items to your site's top navigation bar
-
-1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:
-
-`website/siteConfig.js`
-```javascript
-{
-  headerLinks: [
-    ...
-    /* you can add docs */
-    { doc: 'my-examples', label: 'Examples' },
-    /* you can add custom pages */
-    { page: 'help', label: 'Help' },
-    /* you can add external links */
-    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
-    ...
-  ],
-  ...
-}
-```
-
-For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)
-
-## Adding custom pages
-
-1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
-1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:
-
-`website/siteConfig.js`
-```javascript
-{
-  headerLinks: [
-    ...
-    { page: 'my-new-custom-page', label: 'My New Custom Page' },
-    ...
-  ],
-  ...
-}
-```
-
-For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).
-
-# Full Documentation
-
-Full documentation can be found on the [website](https://docusaurus.io/).

data/docusaurus/website/core/Footer.js

@@ -1,100 +0,0 @@
-/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-const React = require('react');
-
-class Footer extends React.Component {
-  docUrl(doc) {
-    const baseUrl = this.props.config.baseUrl;
-    const docsUrl = this.props.config.docsUrl;
-    const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`;
-    return `${baseUrl}${docsPart}${doc}`;
-  }
-
-  pageUrl(doc, language) {
-    const baseUrl = this.props.config.baseUrl;
-    return baseUrl + (language ? `${language}/` : '') + doc;
-  }
-
-  render() {
-    return (
-      <footer className="nav-footer" id="footer">
-        <section className="sitemap">
-          <a href={this.props.config.baseUrl} className="nav-home">
-            {this.props.config.footerIcon && (
-              <img
-                src={this.props.config.baseUrl + this.props.config.footerIcon}
-                alt={this.props.config.title}
-                width="40"
-                height="39"
-              />
-            )}
-          </a>
-          <div>
-            <h5>Docs</h5>
-            <a href={this.docUrl('getstarted.html')}>
-              Getting Started
-            </a>
-            <a href={this.docUrl('configuration.html')}>
-              Configuration
-            </a>
-            <a href={this.docUrl('rules.html')}>
-              Rules
-            </a>
-            <a href={this.docUrl('commands.html')}>
-              Commands
-            </a>
-            <a href={this.docUrl('development.html')}>
-              Development
-            </a>
-          </div>
-          <div>
-            <h5>More</h5>
-            <a href="https://github.com/sider/goodcheck">GitHub</a>
-            <a
-              className="github-button"
-              href={this.props.config.repoUrl}
-              data-icon="octicon-star"
-              data-count-href="/sider/goodcheck/stargazers"
-              data-show-count="true"
-              data-count-aria-label="# stargazers on GitHub"
-              aria-label="Star this project on GitHub">
-              Star
-            </a>
-            {this.props.config.twitterUsername && (
-              <div className="social">
-                <a
-                  href={`https://twitter.com/${
-                    this.props.config.twitterUsername
-                    }`}
-                  className="twitter-follow-button">
-                  Follow @{this.props.config.twitterUsername}
-                </a>
-              </div>
-            )}
-            {this.props.config.facebookAppId && (
-              <div className="social">
-                <div
-                  className="fb-like"
-                  data-href={this.props.config.url}
-                  data-colorscheme="dark"
-                  data-layout="standard"
-                  data-share="true"
-                  data-width="225"
-                  data-show-faces="false"
-                />
-              </div>
-            )}
-          </div>
-        </section>
-        <section className="copyright">{this.props.config.copyright}</section>
-      </footer>
-    );
-  }
-}
-
-module.exports = Footer;

data/docusaurus/website/package.json

@@ -1,14 +0,0 @@
-{
-  "scripts": {
-    "examples": "docusaurus-examples",
-    "start": "docusaurus-start",
-    "build": "docusaurus-build",
-    "publish-gh-pages": "docusaurus-publish",
-    "write-translations": "docusaurus-write-translations",
-    "version": "docusaurus-version",
-    "rename-version": "docusaurus-rename-version"
-  },
-  "devDependencies": {
-    "docusaurus": "^1.14.4"
-  }
-}

data/docusaurus/website/pages/en/index.js

@@ -1,207 +0,0 @@
-/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-const React = require('react');
-
-class Splash extends React.Component {
-  render() {
-    return (
-      <div className="feature-container">
-        <FeatureDescription
-          title={this.props.info.title}
-          description={this.props.info.description}
-          button={this.props.info.button}
-        />
-        <FeatureCodeBoxExtended info={this.props.info} />
-      </div>
-    );
-  }
-}
-
-const Button = props => (
-  <div className="plugin-wrapper button-wrapper">
-    <a className="button" href={props.href} target={props.target}>
-      {props.children}
-    </a>
-  </div>
-);
-
-class Section extends React.Component {
-  render() {
-
-    return (
-      <div className="section-container">
-        <div className="section-grid">
-          <div className="section-card">
-            <div>
-              <h2>Configuration</h2>
-              <p>Learn the patterns and syntax to make custom rules. </p>
-              <Button href="./docs/configuration">Syntax details</Button>
-            </div>
-          </div>
-          <div className="section-card">
-            <div>
-              <h2>Rules</h2>
-              <p>
-                Want to see some pre-defined rules? Check out some rules here.
-              </p>
-              <Button href="./docs/rules">See rules</Button>
-            </div>
-          </div>
-          <div className="section-card">
-            <div>
-              <h2>Commands</h2>
-              <p>
-                Goodcheck is written to be used on the command line. Learn about
-                it’s usage here.
-              </p>
-              <Button href="./docs/commands">CLI details</Button>
-            </div>
-          </div>
-        </div>
-      </div>
-    );
-  }
-}
-
-class Feature extends React.Component {
-  render() {
-    return (
-      <div className="center-container">
-        <div className="feature-container">
-          <FeatureDescription
-            title={this.props.info.title}
-            description={this.props.info.description}
-          />
-          <FeatureCodeBoxExtended info={this.props.info} />
-        </div>
-      </div>
-    );
-  }
-}
-
-class FeatureDescription extends React.Component {
-  render() {
-    return (
-      <div className="description-container">
-        <h1>{this.props.title}</h1>
-        <p>{this.props.description}</p>
-        {this.props.button && (
-          <Button href="./docs/getstarted">{this.props.button}</Button>
-        )}
-      </div>
-    );
-  }
-}
-
-class FeatureCodeBoxExtended extends React.Component {
-  render() {
-    const info = this.props.info;
-    return (
-      <div className="code-container">
-        <header className="code-top">goodcheck.yml</header>
-        <section className="code-content">
-          <pre className="yaml">
-            <span className="yaml-key">rules</span>
-            <span className="yaml-syntax">: </span>
-            <br />
-            <span className="yaml-syntax">{`  - `}</span>
-            <span className="yaml-key">id</span>
-            <span className="yaml-syntax">: </span>
-            <span className="yaml-value">{info.id}</span>
-            <br />
-            {info.not && (
-              <div>
-                <span className="yaml-key">{`    not`}</span>
-                <span className="yaml-syntax">: </span>
-                <br />
-                <span className="yaml-key">{`      pattern`}</span>
-                <span className="yaml-syntax">: </span>
-                <span className="yaml-value">{info.pattern}</span>
-                <br />
-              </div>
-            )}
-            {!info.not && (
-              <div>
-                {info.pattern && (
-                  <div>
-                    <span className="yaml-key">{`    pattern`}</span>
-                    <span className="yaml-syntax">: </span>
-                    <span className="yaml-value">{info.pattern}</span>
-                  </div>
-                )}
-              </div>
-            )}
-            <span className="yaml-key">{`    message`}</span>
-            <span className="yaml-syntax">: </span>
-            <span className="yaml-value">{`${info.message}`}</span>
-            <br />
-            {info.glob && (
-              <div>
-                <span className="yaml-key">{`    glob`}</span>
-                <span className="yaml-syntax">: </span>
-                <span className="yaml-value">{`${info.glob}`}</span>
-              </div>
-            )}
-          </pre>
-        </section>
-        <header className="code-result">Result</header>
-        <section className="code-terminal">
-          <p className="yaml">
-            {`${info.resultFront}`}
-            {info.match && (
-              <span className="terminal-highlight"> {info.match} </span>
-            )}
-            {info.resultEnd && `${info.resultEnd}`}
-          </p>
-        </section>
-      </div>
-    );
-  }
-}
-
-class Index extends React.Component {
-  render() {
-    const { config: siteConfig } = this.props;
-
-    const Showcase = () => {
-
-      return (
-        <div className="productShowcaseSection paddingBottom showcaseBackground">
-          <br />
-          <h2>Stop reviewing the same patterns.</h2>
-          <Button href="./docs/getstarted">Start using {siteConfig.title}</Button>
-        </div>
-      );
-    };
-
-    const MainContainer = () => {
-      return (
-        <div className="index-container">
-          <div className="splash-container">
-            <Splash info={siteConfig.splash} />
-          </div>
-          <div className="three-features-container">
-            <Section />
-            <Feature info={siteConfig.featureOne} />
-            <Feature info={siteConfig.featureTwo} />
-            <Feature info={siteConfig.featureThree} />
-          </div>
-        </div>
-      );
-    }
-
-    return (
-      <div>
-        <MainContainer />
-        <Showcase />
-      </div>
-    );
-  }
-}
-
-module.exports = Index;