# grunt-angular-sitemap

> Grunt plugin to generate a sitemap from an Angular project

Latest version **1.1.0** (published 2022-03-04) · GNU v3.0 license · 0 weekly downloads

## Install

```sh
npm install grunt-angular-sitemap
pnpm add grunt-angular-sitemap
yarn add grunt-angular-sitemap
bun add grunt-angular-sitemap
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-03-04 |
| First published | 2018-12-31 |
| Weekly downloads | 0 |
| License | GNU v3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 2 |
| Unpacked size | 46.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nicolas De Smyter |
| Maintainers | ndsmyter |
| Keywords | gruntplugin, grunt, angular, sitemap |

## Links

- npm: https://www.npmjs.com/package/grunt-angular-sitemap
- Repository: https://github.com/ndsmyter/grunt-angular-sitemap
- Issues: https://github.com/ndsmyter/grunt-angular-sitemap/issues
- npm.io page: https://npm.io/package/grunt-angular-sitemap

## Dependencies (2)

- [xmlbuilder](https://npm.io/package/xmlbuilder.md) ^15.1.1
- [string-similarity](https://npm.io/package/string-similarity.md) ^4.0.4

## Recent versions

- 1.1.0 (latest) — 2022-03-04
- 1.0.3 — 2018-12-31
- 1.0.2 — 2018-12-31
- 1.0.1 — 2018-12-31
- 1.0.0 — 2018-12-31

## README

# grunt-angular-sitemap

> Grunt plugin to generate a sitemap from an Angular project

## Getting Started
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-angular-sitemap --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-angular-sitemap');
```

## The "angular_sitemap" task

### Overview
In your project's Gruntfile, add a section named `angular_sitemap` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  angular_sitemap: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});
```

### Options

#### options.rootUrl
Type: `String`
Default value: `https://test.com`

The root URL that will be used to start the URLs in the sitemap with.

#### options.dest
Type: `String`
Default value: `dist`

The destination folder in which the sitemaps will be generated.

#### options.ignore
Type: `Array`
Default value: `[]`

The list of paths that will be ignored from the final sitemap.
This can be used to make sure some private URLs don't get any public attention.

#### options.output
Type: `String`
Default value: `txt`

Choose the output format of the sitemap.
The supported formats are `txt` or `xml`.

#### options.ignore
Type: `Array`
Default value: `[]`

The list of paths that will be ignored from the final sitemap.
This can be used to make sure some private URLs don't get any public attention.

#### options.manual
Type: `Array`
Default value: `xml`

The list of paths that will be manually added to the final sitemap.
This is the best choice to add some URLs that are not actually in the Angular project,
but should be in the sitemap.


### Usage Examples

#### Default Options
The default options will generate an XML sitemap in the `dist` folder.
Don't forget to pass a list of route files to the plugin.

```js
grunt.initConfig({
  angular_sitemap: {
    options: {
        rootUrl: 'https://test.com/',
        dest: 'dist',
        ignore: [],
        output: 'xml',
        manual: []
    },
    expand: true,
    cwd: 'src',
    src: ['**/*.routes.ts']
  },
});
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style.
Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
1.0 First version with some basic options

---
_Source: https://npm.io/package/grunt-angular-sitemap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._