grunt-angular-robot

0.0.1 • Public • Published

grunt-angular-robot 0.0.1

Grunt plugin to generate robot.txt based on angular paths. Specify the allowed behavior by the robot as you write your app so you dont have to go back and write the robot.txt file by yourself.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-angular-robot --save-dev

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

grunt.loadNpmTasks('grunt-angular-robot');

The "angular_robot" task

Overview

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

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

Usage Examples

Define your source (where your routes are defined e.g. app.js) and the destination (the robot.txt file)

grunt.initConfig({
  angular_robot: {
    files: {
      'builds/dist/robots.txt': ['src/app.js'],
    },
  },
});

On your angular app every time you define a path specify if the robot will be able to index it or not. If you dont specify allow will be used.

      $routeProvider.when('/', {
        templateUrl: 'partials/home/home.html',
        controller: 'HomeController',
        controllerAs: 'home',
        robots: 'allow'
      }).when('/page1', {
        templateUrl: 'partials/pages/page1.html',
        controller: 'PageController',
        controllerAs: 'page1',
        robots: 'disallow'
      }).when('/page2', {
        templateUrl: 'partials/pages/page2.html',
        controller: 'PageController',
        controllerAs: 'page2',
      })

The tasks will read the source and generate the following robot.txt file.

User-agent: * 
allow: /
disallow: /page1
allow: /page2

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

28-02-2015: version 0.0.1

Package Sidebar

Install

npm i grunt-angular-robot

Weekly Downloads

2

Version

0.0.1

License

none

Last publish

Collaborators

  • avrmav