grunt-textfile

A grunt task to quickly create text files for text-based blogging.

Getting Started

This plugin requires Grunt ~0.4.1

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-textfile --save-dev

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

grunt.loadNpmTasks('grunt-textfile');

The "textfile" task

Overview

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

grunt.initConfig({
  textfile: {
    options: {
      dest: 'content/blog',
    },
    linkpost: {
      options: {
        template: 'kirby-linkpost.tpl',
        urlFormat: 'PREFIX-SLUG/article.link.txt'
      }
    },
    article: {
      options: {
          template: 'kirby-article.tpl',
          urlFormat: 'PREFIX-SLUG/article.txt'
      }
    }
  }
})

Templates

Store your templates in the templates folder and use the grunt.template and the grunt.option API for placeholders.

Example template:

Title: <%= grunt.option('title') %>
----
Link: <%= grunt.option('link') %>
----
Date: <%= grunt.template.today('yyyy-mm-dd') %>
----
Author: Jean-Luc Picard
----
Text:

Options

options.template

Type: String
Default value: 'example.tpl'

options.templateDir

Type: String
Default value: 'templates'

options.templateDir

Destination for the generated file. Needs to be set to the folder in which your text files are stored.
Type: String
Default value: 'tmp'

options.urlDateFormat

In case you need to use the date the name of the generated file, you can change the format with this option.
Type: String
Default value: 'yyyy-mm-dd'

options.urlFormat

Type: String
Default Value: 'PREFIX-SLUG/article.link.txt'

This option lets you set the desired formatting of the filename. There are 3 keywords you can use in here:

// PREFIX is needed for Kirby blogs. It prepends an ascending number to the folder name 
// of the folder containing your textfile
'PREFIX' 
// This keyword is replaced by the slug generated with the title
'SLUG'
// This keyword is replaced by the date of today 
// formatted via options.urlDateFormat
'DATE'

Usage Examples

Kirby Link Post

Gruntfile:

grunt.initConfig({
  textfile: {
    options: {
      dest: 'content/blog'
    },
    linkpost: {
      options: {
        template: 'kirby-linkpost.tpl',
        urlFormat: 'PREFIX-SLUG/article.link.txt'
      }
    }
  },
})

Template:

Title: <%= grunt.option('title') %>
----
Link: <%= grunt.option('link') %>
----
Date: <%= grunt.template.today('yyyy-mm-dd') %>
----
Author: kahlil-lechelt
----
Text:

Call:

grunt textfile --link="http://thisisalink.net" --title="This is a title"

Jekyll Post

Gruntfile:

grunt.initConfig({
  textfile: {
    options: {
      dest: '_posts'
    },
    article: {
      options: {
        template: 'jekyll-article.tpl',
        urlFormat: 'DATE-SLUG.md'
      }
    }
  },
})

Template:

---
Title: <%= grunt.option('title') %>
Date: <%= grunt.template.today('yyyy-mm-dd') %>
Author: kahlil-lechelt
---

Call:

grunt textfile --title="This is a title"

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

v0.1.0: initial release