Skip to content

Commit

Permalink
get ready for initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
jamis committed Mar 9, 2009
1 parent be48eb7 commit 81023c9
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 0 deletions.
20 changes: 20 additions & 0 deletions MIT-LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2009 Jamis Buck

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.
53 changes: 53 additions & 0 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
ProjectSearch
=============

The project searcher is like a Rails-aware grep that can be used to quickly
search specific areas of your project. Even if you're already proficient with
the Unix find and grep commands, this finder tool can save you precious
key-strokes.

Installing the plugin adds a 'find' script under your project's 'script'
directory.

You invoke the command with an optional "scope", and a "term" (a regular
expression pattern) to search for. If the scope is omitted, it defaults to
"all". The supported scopes and their meanings are:

* "all": search app, config, lib, test, and public directories.
* "code": search app (except for app/views), config, lib, and test.
* "css": search just the public/stylesheets directory.
* "js": search just the public/javascripts directory.

You can also specify "helper", "model", "presenter", "service", "view"
"controller", or "concern", which will search in the pluralized version of
that directory under "app".

Any other scope argument is interpreted to mean the directory name itself that
you want to search.

Note that only files with the following extensions are searched:

* rb
* rjs
* rhtml
* rxml
* erb
* builder
* css
* js
* html

Examples:

# searches all significant project directories for files that
# contain the string "FIXME".
script/find FIXME

# searches all javascript and view files for Ajax.Request.
script/find js Ajax.Request

# searches the project's helpers for all method definitions
# starting with "emit_":
script/find helper "def emit_"

Copyright (c) 2009 Jamis Buck, released under the MIT license

0 comments on commit 81023c9

Please sign in to comment.