goodcheck 2.4.0 → 2.4.1

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

@@ -0,0 +1,207 @@
+/**
+ * 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;

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

@@ -0,0 +1,118 @@
+/**
+ * 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');
+
+const CompLibrary = require('../../core/CompLibrary');
+
+const Container = CompLibrary.Container;
+
+const CWD = process.cwd();
+
+const versions = require(`${CWD}/versions.json`);
+
+function Versions(props) {
+  const { config: siteConfig } = props;
+  const latestVersion = versions[0];
+  const repoUrl = `https://github.com/${siteConfig.organizationName}/${
+    siteConfig.projectName
+    }`;
+  return (
+    <div className="docMainWrapper wrapper">
+      <Container className="mainContainer versionsContainer">
+        <div className="post">
+          <header className="postHeader">
+            <h1>{siteConfig.title} Versions</h1>
+          </header>
+          <p>New versions of this project are released every so often.</p>
+          <h3 id="latest">Current version (Stable)</h3>
+          <table className="versions">
+            <tbody>
+              <tr>
+                <th>{latestVersion}</th>
+                <td>
+                  {/* You are supposed to change this href where appropriate
+                        Example: href="<baseUrl>/docs(/:language)/:id" */}
+                  <a
+                    href={`${siteConfig.baseUrl}${siteConfig.docsUrl}/${
+                      props.language ? props.language + '/' : ''
+                      }configuration`}>
+                    Documentation
+                  </a>
+                </td>
+                <td>
+                  <a href="https://github.com/sider/goodcheck/releases">Release Notes</a>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+          <p>
+            This is the version that is configured automatically when you first
+            install this project.
+          </p>
+          <h3 id="rc">Pre-release versions</h3>
+          <table className="versions">
+            <tbody>
+              <tr>
+                <th>master</th>
+                <td>
+                  {/* You are supposed to change this href where appropriate
+                        Example: href="<baseUrl>/docs(/:language)/next/:id" */}
+                  <a
+                    href={`${siteConfig.baseUrl}${siteConfig.docsUrl}/${
+                      props.language ? props.language + '/' : ''
+                      }next/configuration`}>
+                    Documentation
+                  </a>
+                </td>
+                <td>
+                  <a href={repoUrl}>Source Code</a>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+          <p>Other text describing this section.</p>
+          <h3 id="archive">Past Versions</h3>
+          <p>Here you can find previous versions of the documentation.</p>
+          <table className="versions">
+            <tbody>
+              {versions.map(
+                version =>
+                  version !== latestVersion && (
+                    <tr>
+                      <th>{version}</th>
+                      <td>
+                        {/* You are supposed to change this href where appropriate
+                        Example: href="<baseUrl>/docs(/:language)/:version/:id" */}
+                        <a
+                          href={`${siteConfig.baseUrl}${siteConfig.docsUrl}/${
+                            props.language ? props.language + '/' : ''
+                            }${version}/configuration`}>
+                          Documentation
+                        </a>
+                      </td>
+                      <td>
+                        <a href={`${repoUrl}/releases/tag/v${version}`}>
+                          Release Notes
+                        </a>
+                      </td>
+                    </tr>
+                  ),
+              )}
+            </tbody>
+          </table>
+          <p>
+            You can find past versions of this project on{' '}
+            <a href={repoUrl}>GitHub</a>.
+          </p>
+        </div>
+      </Container>
+    </div>
+  );
+}
+
+module.exports = Versions;

data/docusaurus/website/sidebars.json

@@ -0,0 +1,11 @@
+{
+    "Goodcheck": {
+        "Docs": [
+            "getstarted",
+            "configuration",
+            "rules",
+            "commands",
+            "development"
+        ]
+    }
+}

data/docusaurus/website/siteConfig.js

@@ -0,0 +1,171 @@
+/**
+ * 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.
+ */
+
+// See https://docusaurus.io/docs/site-config for all the possible
+// site configuration options.
+
+// List of projects/orgs using your project for the users page.
+// const users = [
+//   {
+//     caption: 'User1',
+//     // You will need to prepend the image path with your baseUrl
+//     // if it is not '/', like: '/test-site/img/image.jpg'.
+//     image: 'https://github.com/sider/goodcheck/raw/master/logo/GoodCheck%20Horizontal.png',
+//     infoLink: 'https://github.com/sider/goodcheck',
+//     pinned: true,
+//   },
+// ];
+
+const siteConfig = {
+  title: 'Goodcheck', // Title for your website.
+  tagline: 'A regexp based customizable linter',
+  url: 'https://sider.github.io', // Your website URL
+  baseUrl: '/goodcheck/', // Base URL for your project */
+  // For github.io type URLs, you would set the url and baseUrl like:
+  //   url: 'https://facebook.github.io',
+  //   baseUrl: '/test-site/',
+
+  // Used for publishing and more
+  projectName: 'goodcheck',
+  organizationName: 'sider',
+  // For top-level user or org sites, the organization is still the same.
+  // e.g., for the https://JoelMarcey.github.io site, it would be set like...
+  //   organizationName: 'JoelMarcey'
+
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    { doc: 'getstarted', label: 'Get Started' },
+    { doc: 'configuration', label: 'Configuration' },
+    { doc: 'rules', label: 'Rule' },
+    { doc: 'commands', label: 'Commands' },
+  ],
+
+  // If you have users set above, you add it here:
+  // users,
+
+  /* path to images for header/footer */
+  headerIcon: 'img/favicon.ico',
+  footerIcon: 'img/favicon.ico',
+  favicon: 'img/favicon.ico',
+
+  /* Colors for website */
+  colors: {
+    primaryColor: '#09345D', // hsl(209, 82%, 19%)
+    secondaryColor: '#044d82',
+    lightColor: '#eaeef3',
+  },
+
+  /* Custom fonts for website */
+  /*
+  fonts: {
+    myFont: [
+      "Times New Roman",
+      "Serif"
+    ],
+    myOtherFont: [
+      "-apple-system",
+      "system-ui"
+    ]
+  },
+  */
+
+  // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
+  copyright: `Copyright © ${new Date().getFullYear()} Goodcheck`,
+
+  highlight: {
+    // Highlight.js theme to use for syntax highlighting in code blocks.
+    theme: 'mono-blue',
+  },
+
+  // Add custom scripts here that would be placed in <script> tags.
+  scripts: [
+    'https://buttons.github.io/buttons.js',
+    'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+    '/js/code-block-buttons.js',
+  ],
+  stylesheets: ['/css/code-block-buttons.css'],
+
+  // On page navigation for the current documentation page.
+  onPageNav: 'separate',
+  // No .html extensions for paths.
+  cleanUrl: true,
+
+  // Open Graph and Twitter card images.
+  // ogImage: 'img/undraw_online.svg',
+  // twitterImage: 'img/undraw_tweetstorm.svg',
+
+  // For sites with a sizable amount of content, set collapsible to true.
+  // Expand/collapse the links and subcategories under categories.
+  // docsSideNavCollapsible: true,
+
+  // Show documentation's last contributor's name.
+  // enableUpdateBy: true,
+
+  // Show documentation's last update time.
+  // enableUpdateTime: true,
+
+  // You may provide arbitrary config keys to be used as needed by your
+  // template. For example, if you need your repo's URL...
+  repoUrl: 'https://github.com/sider/goodcheck',
+
+  splash: {
+    title: `Goodcheck`,
+    description: "A regexp based customizable linter",
+    button: "Get Started",
+    id: "com.example.github",
+    pattern: "Github",
+    message: `|
+      GitHub is GitHub, not Github
+  
+      You may have misspelling the name of the service!`,
+    resultFront: `index.html: 91:    - <a>Signup via `,
+    match: "Github",
+    resultEnd: `</a>:    GitHub is GitHub, not Github`
+  },
+
+  featureOne: {
+    title: `A Goodcheck rule`,
+    description:
+      "Define patterns with messages in a goodcheck.yml file and run goodcheck within your repository. Any matching results will be displayed in the terminal.",
+    id: "com.sample.no-blink",
+    pattern: "<blink",
+    message: `|
+      Stop using <blink> tag`,
+
+    resultFront: `index.html:50:          <h3>`,
+    match: "<blink>",
+    resultEnd: `HTML5 Markup</blink></h3>:   Stop using <blink> tag`
+  },
+
+  featureTwo: {
+    title: `A rule with negated pattern`,
+    description:
+      "Goodcheck rules are usually to detect if something is included in a file. You can define the negated rules for the opposite, something is missing in a file.",
+    id: "com.sample.negated",
+    not: true,
+    pattern: "<!DOCTYPE html>",
+    message: `|
+      Write a doctype on HTML files.`,
+
+    resultFront: `index.html:-:<html lang="en">:  Write a doctype on HTML files.`,
+    glob: "**/*.html"
+  },
+
+  featureThree: {
+    title: `A rule without pattern`,
+    description:
+      "You can define a rule without pattern. The rule emits an issue on each file specified with glob. You cannot omit glob from a rule definition without pattern. ",
+    id: "com.sample.without_pattern",
+    message: `|
+      Read the operation manual for DB migration: https://example.com/guides/123 `,
+
+    resultFront: `db/schema.rb:-:# This file is auto-generated from the current state of the database. Instead: Read the operation manual for DB migration: https://example.com/guides/123`,
+    glob: "db/schema.rb"
+  },
+};
+
+module.exports = siteConfig;