Skip to content

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
postmodern committed Jan 22, 2011
0 parents commit 53bb332
Show file tree
Hide file tree
Showing 12 changed files with 148 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .document
@@ -0,0 +1,3 @@
-
ChangeLog.*
LICENSE.txt
2 changes: 2 additions & 0 deletions .gitignore
@@ -0,0 +1,2 @@
doc/
pkg/
1 change: 1 addition & 0 deletions .rspec
@@ -0,0 +1 @@
--colour --format documentation
1 change: 1 addition & 0 deletions .yardopts
@@ -0,0 +1 @@
--markup markdown --title "yard-spellcheck Documentation" --protected
4 changes: 4 additions & 0 deletions ChangeLog.md
@@ -0,0 +1,4 @@
### 0.1.0 / 2011-01-21

* Initial release:

20 changes: 20 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,20 @@
Copyright (c) 2011 Hal Brodigan

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 changes: 28 additions & 0 deletions README.md
@@ -0,0 +1,28 @@
# yard-spellcheck

* [Homepage](http://github.com/postmodern/yard-spellcheck)
* [Issues](http://github.com/postmodern/yard-spellcheck/issues)
* [Email](postmodern.mod3 at gmail.com)

## Description

TODO: Description

## Synopsis

$ yard spellcheck

## Requirements

* [yard](http://github.com/lsegal/yard) ~> 0.6.0
* [ffi-hunspell](http://github.com/postmodern/ffi-hunspell) ~> 0.1.0

## Install

$ gem install yard-spellcheck

## Copyright

Copyright (c) 2011 Hal Brodigan

See {file:LICENSE.txt} for details.
35 changes: 35 additions & 0 deletions Rakefile
@@ -0,0 +1,35 @@
require 'rubygems'
require 'rake'

begin
gem 'ore-tasks', '~> 0.3.0'
require 'ore/tasks'

Ore::Tasks.new
rescue LoadError => e
STDERR.puts e.message
STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
end

begin
gem 'rspec', '~> 2.4.0'
require 'rspec/core/rake_task'

RSpec::Core::RakeTask.new
rescue LoadError => e
task :spec do
abort "Please run `gem install rspec` to install RSpec."
end
end
task :default => :spec

begin
gem 'yard', '~> 0.6.0'
require 'yard'

YARD::Rake::YardocTask.new
rescue LoadError => e
task :yard do
abort "Please run `gem install yard` to install YARD."
end
end
20 changes: 20 additions & 0 deletions gemspec.yml
@@ -0,0 +1,20 @@
name: yard-spellcheck
version: 0.1.0
summary: Spellcheck your YARD documentat
description:
Adds the 'spellcheck' command to YARD, which will spellcheck every
docstring within your documentation.

license: MIT
authors: Postmodern
email: postmodern.mod3@gmail.com
homepage: http://github.com/postmodern/yard-spellcheck
has_yard: true

dependencies:
yard: ~> 0.6.0
ffi-hunspell: ~> 0.1.0

development_dependencies:
ore-tasks: ~> 0.3.0
rspec: ~> 2.4.0
17 changes: 17 additions & 0 deletions lib/yard/cli/spellcheck.rb
@@ -0,0 +1,17 @@
module YARD
module CLI
class Spellcheck < Command

def initialize
end

def description
'Spellchecks YARD documentation'
end

def run(*args)
end

end
end
end
2 changes: 2 additions & 0 deletions spec/spec_helper.rb
@@ -0,0 +1,2 @@
gem 'rspec', '~> 2.4.0'
require 'rspec'
15 changes: 15 additions & 0 deletions yard-spellcheck.gemspec
@@ -0,0 +1,15 @@
# -*- encoding: utf-8 -*-

begin
Ore::Specification.new do |gemspec|
# custom logic here
end
rescue NameError
begin
require 'ore/specification'
retry
rescue LoadError
STDERR.puts "The 'yard-spellcheck.gemspec' file requires Ore."
STDERR.puts "Run `gem install ore-core` to install Ore."
end
end

0 comments on commit 53bb332

Please sign in to comment.