# @carbondigital/robots-generator

> Robots generator that is used in our SEO application.

Latest version **0.0.1** (published 2022-10-23) · GNU license · 0 weekly downloads

## Install

```sh
npm install @carbondigital/robots-generator
pnpm add @carbondigital/robots-generator
yarn add @carbondigital/robots-generator
bun add @carbondigital/robots-generator
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2022-10-23 |
| First published | 2022-10-23 |
| Weekly downloads | 0 |
| License | GNU |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.14.0 |
| Dependencies | 0 |
| Unpacked size | 51.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Carbon Digital |
| Maintainers | jared.ledbetter |
| Keywords | seo, robots, generator, typescript, node, sem, links |

## Links

- npm: https://www.npmjs.com/package/@carbondigital/robots-generator
- Repository: https://github.com/carbondigitalus/semlinks-robots-generator
- Homepage: https://github.com/carbondigitalus/semlinks-robots-generator#readme
- Issues: https://github.com/carbondigitalus/semlinks-robots-generator/issues
- npm.io page: https://npm.io/package/@carbondigital/robots-generator

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2022-10-23

## README

<div id="top"></div>
<!-- PROJECT SHIELDS -->

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/carbondigitalus/sem-links/">
    <img src="_repo/logo.png" alt="Logo" width="400" height="">
  </a>
  <h3 align="center">SEM Links</h3>
  <p align="center">
    Search Engine Marketing (SEM) Links, which is the working title, is a Search Engine Optimization (SEO) tool. The current goal is to tackle all of the technical SEO areas of concern. The end goal aims much higher.
    <br>
    <br>
    <a href="https://github.com/carbondigitalus/sem-links/issues" target="_blank">Module Bugs</a>
    ·
    <a href="https://semlinks.canny.io/semlinks" target="_blank">SEM Links Features</a>
  </p>
</div>

<!-- TABLE OF CONTENTS -->
<aside>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</aside>

<!-- ABOUT THE PROJECT -->

## About The Project

We wanted a tool internally that would help us rapidly scale our SEO efforts, but ultimately, give us the ability to migrate offf our current toolchain for SEO. Like many agencies, our team spent thousands on SEO-realted software each year. Since we're not a multi-million dollar agency, it always hurts to pay those bills.

In light of that, we are building this software initially for our own team. We have already seen the power of competing with well-known tools that currently exist. One thing we aim to achieve is more honesty and more transparency. This is why we are building some modules has open-source NPM packages. So, give all developers the ability to see exactly what we're doing and contribute if they desire.

<p align="right">(<a href="#top">back to top</a>)</p>

### Built With

Below are the major frameworks/libraries that are currently used in this project, or soon to be added in a future release.

- [Node.js](https://nodejs.org/)
- [TypeScript](https://typescript.com/)

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- USAGE EXAMPLES -->

## Usage

Setup Data Config for the Robots file:

```json
// required file name: data.robots.json
{
  "data": []
}
```

Inside the data array, each object follows the interface formats:

```ts
export interface DataFile {
  data: Line[];
}
export interface Line {
  type: LineType;
  content: string;
}
export enum LineType {
  allow = 'allow',
  blank = 'blank',
  comment = 'comment',
  crawlDelay = 'crawl-delay',
  disallow = 'disallow',
  sitemap = 'sitemap',
  userAgent = 'user-agent',
  other = 'other'
}
```

This translates into the following examples for each `LineType`. Currently, the `other` type doesn't output any results. If you have a need to capture other directives that haven't been included, please submit a bug so that we can review and research it.

```json
{
  "data": [
    {
      "type": "allow",
      "content": "/wp-admin/admin-ajax.php"
    },
    {
      "type": "blank",
      "content": ""
    },
    {
      "type": "comment",
      "content": "sitemaps section"
    },
    {
      "type": "crawl-delay",
      "content": "10"
    },
    {
      "type": "disallow",
      "content": "/wp-admin/"
    },
    {
      "type": "sitemap",
      "content": "https://carbondigital.us/sitemaps/post-sitemap1.xml"
    },
    {
      "type": "user-agent",
      "content": "SemrushBot"
    },
    {
      "type": "other",
      "content": ""
    }
  ]
}
```

Console.Log your robots.txt file:

```js
import { robotsParser } from '@carbondigital/robots-parser';
robotsParser('console', './my-robots-file.txt');
```

Logged Output:

```
Sitemap: https://carbondigital.us/sitemaps/post-sitemap1.xml
Sitemap: https://carbondigital.us/sitemaps/page-sitemap1.xml
Sitemap: https://carbondigital.us/sitemaps/projects-sitemap1.xml
Sitemap: https://carbondigital.us/sitemaps/services-sitemap1.xml
Sitemap: https://carbondigital.us/sitemaps/locations-sitemap1.xml
Sitemap: https://carbondigital.us/sitemaps/category-sitemap1.xml

User-agent: SemrushBot
    Disallow: /
User-agent: SemrushBot-SA
    Disallow: /
User-agent: MJ12bot
    Disallow: /
User-agent: Mediapartners-Google
    Disallow:
User-agent: Googlebot-Image
    Disallow:
User-agent: *
    Disallow: /wp-admin/
    Allow: /wp-admin/admin-ajax.php
```

<!--
_For more examples, please refer to the [Documentation](https://example.com)_
-->

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- ROADMAP -->

## Roadmap

We've got a simple setup on Canny. You can submit either a Github issue, or a Canny feature request for the SEM Links tool.

- [Feature Requests in Canny](https://semlinks.canny.io/semlinks)

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again! See contributing.md for more details.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- ACKNOWLEDGMENTS -->

## Acknowledgments

Without these people and tools, life would be too complicated.

- Family and Friends.
- Ramen, Rice, Cheeseburgers and Pizza.
- [Carbon Digital](https://carbondigital.us)
- [Font Awesome](https://fontawesome.com)
- [VS Code](https://code.visualstudio.com/)

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/carbondigitalus/sem-links.svg?style=for-the-badge
[contributors-url]: https://github.com/carbondigitalus/sem-links/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/carbondigitalus/sem-links.svg?style=for-the-badge
[forks-url]: https://github.com/carbondigitalus/sem-links/network/members
[stars-shield]: https://img.shields.io/github/stars/carbondigitalus/sem-links.svg?style=for-the-badge
[stars-url]: https://github.com/carbondigitalus/sem-links/stargazers
[issues-shield]: https://img.shields.io/github/issues/carbondigitalus/sem-links.svg?style=for-the-badge
[issues-url]: https://github.com/carbondigitalus/sem-links/issues
[license-shield]: https://img.shields.io/github/license/carbondigitalus/sem-links.svg?style=for-the-badge
[license-url]: https://github.com/carbondigitalus/sem-links/blob/master/license.md
[canny-url]: https://semlinks.canny.io/semlinks

---
_Source: https://npm.io/package/@carbondigital/robots-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._