site/index.html

<!doctype html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>publint</title>
    <meta
      name="description"
      content="Lint npm packages to ensure widest compatibility across environments."
    />
    <script type="module" src="./src/main.js"></script>
  </head>
  <body tabindex="-1">
    <div id="app" class="min-h-4xl"></div>
    <footer
      id="docs"
      class="docs bg-gray-300 text-dark @dark:bg-gray-800 @dark:text-white py-8"
    >
      <div
        class="mb-2 px-4 flex flex-col md:flex-row w-full max-w-6xl mx-auto gap-6"
      >
        <section class="md:w-1/2 mb-2">
          <h2>What is publint</h2>
          <p>
            <code>publint</code> lints npm packages to ensure the widest
            compatibility across environments, such as Vite, Webpack, Rollup,
            Node.js, etc.
          </p>
          <p>
            A full list of lint rules can be found at the
            <a class="anchor-link" href="/rules.html">rules page</a>.
          </p>
        </section>
        <section class="md:w-1/2 mb-2">
          <h2>How it works</h2>
          <p>
            Given an npm package, the site downloads the tarball from the npm
            registry, and runs <code>publint</code> against it in a web worker.
            For larger packages, it may take a while to download and lint.
          </p>
          <p>
            You can also directly paste
            <a href="https://www.npmjs.com">www.npmjs.com</a> or
            <a href="https://pkg.pr.new">pkg.pr.new</a>
            links in the search input to easily lint them!
          </p>
        </section>
      </div>
      <div
        class="mb-8 px-4 flex flex-col md:flex-row w-full max-w-6xl mx-auto gap-6"
      >
        <section class="md:w-1/2 mb-2">
          <h2>Use locally</h2>
          <ul>
            <li>
              Run <code>npx publint</code> in your library directory to lint
              locally.
            </li>
            <li>Run <code>npx publint deps</code> to lint dependencies.</li>
            <li>
              Run <code>npx publint --help</code> for the full list of options.
            </li>
          </ul>
        </section>
        <section class="md:w-1/2 mb-2">
          <h2>Other resources</h2>
          <ul>
            <li>
              <a class="anchor-link" href="https://arethetypeswrong.github.io">
                Are the types wrong?
              </a>
            </li>
            <li>
              <a
                class="anchor-link"
                href="https://github.com/frehner/modern-guide-to-packaging-js-library"
              >
                Modern Guide to Packaging JS Library
              </a>
            </li>
            <li>
              <a
                class="anchor-link"
                href="https://hirok.io/posts/package-json-exports"
              >
                Guide to the package.json exports field
              </a>
            </li>
          </ul>
        </section>
      </div>
      <div class="text-center docs">
        <p>
          Made by
          <a class="text-white anchor-link" href="https://bjornlu.com">
            Bjorn Lu
          </a>
        </p>
      </div>
    </footer>
  </body>
</html>