Commit Graph

357 Commits

Author SHA1 Message Date
William Melody 13d1428ee9 Add large ascii text of name to Readme 2015-05-20 20:31:05 -07:00
William Melody d5b6456766 Bump version to 1.4.0 2015-05-20 16:49:46 -07:00
William Melody db2b5ad074 Add expanded installtion instructions to Readme
Include command for manual and bpkg installation methods.
2015-05-20 16:48:08 -07:00
William Melody 371b644f6f Add package.json for bpkg 2015-05-20 16:47:32 -07:00
William Melody 87bce12994 Add basic Makefile
This simply installs the script to /usr/local/bin
2015-05-20 16:46:02 -07:00
William Melody 08d899fee5 Fix inert indentation typo. 2015-04-28 16:54:25 -07:00
William Melody 9a395fd017 Bump version to 1.3.0 2015-04-18 21:23:45 -07:00
William Melody 26ad499fee Spelling correction: formmatted_comment -> formatted_comment 2015-04-18 21:21:46 -07:00
William Melody 2c83de9dff Declare and assign separately to avoid masking return values.
ShellCheck SC2155

https://github.com/koalaman/shellcheck/wiki/SC2155
2015-04-18 21:17:46 -07:00
William Melody cb9e20e554 Use capitalized form of $_ME variable.
The capitalized version of this variable makes it easier to override,
even though this is not technically part of the external API. There is
no known downside of using the capitalized version of the variable.
2015-04-18 21:06:26 -07:00
William Melody e62bede843 Bump version to 1.2.0 2015-03-20 18:11:42 -07:00
William Melody c2ca24b459 Verify that matching records have been found in `remove` before removing 2015-03-20 18:10:51 -07:00
William Melody 312f5909fa Add ability to add an option comment when adding a record
This addition requires a number of changes including:

- the addition of a new `_join` function
- reformatting of the `add` function to facilitate the longer lines
2015-03-20 18:06:00 -07:00
William Melody 023aa0503f Add `enabled` and `disabled` to command list in `--help` 2015-03-20 17:23:31 -07:00
William Melody f10be24da7 Bump version to 1.1.0 2015-03-20 16:49:24 -07:00
William Melody 7e32a799c2 Add `enabled` and `disabled` commands.
Both of these are just aliases for the `list ( enabled | disabled )`
commands, providing a shorter way to access the same functionality.
2015-03-20 16:49:08 -07:00
William Melody 52529dd029 Correct typo in `help` usage + add info about `--force` in Readme 2015-03-19 17:14:04 -07:00
William Melody e6ee93da47 Add command information to Readme 2015-03-19 14:43:32 -07:00
William Melody 0830fa43b8 Simplify "strict mode" section in order to avoid too much noise
These comments can be found in the bash-boilerplate project and aren't
necessary here. Since the $DEFAULT_IFS doesn't appear to be used,
either, the $IFS setting can be reduced to a since simple assignment.
2015-03-19 14:30:51 -07:00
William Melody bcf308ffd3 Bump version to 1.0.0 2015-03-18 18:45:00 -07:00
William Melody 531594f74f Add 'Why' section to Readme 2015-03-18 18:44:06 -07:00
William Melody db5cf5a97b Use more consistent spacing in usage statements. 2015-03-18 18:41:04 -07:00
William Melody 2ab32d006a Add license 2015-03-18 18:39:22 -07:00
William Melody cf56224732 Add installation information to Readme. 2015-03-18 18:35:45 -07:00
William Melody b5a2b28884 Remove redundant command usage entry in `help` 2015-03-18 18:28:38 -07:00
William Melody 37e9618359 Clarify help command usage in Readme. 2015-03-18 18:23:59 -07:00
William Melody 5844aa19a3 Use 'search string' consistently instead of mixing with 'search term' 2015-03-18 18:22:37 -07:00
William Melody 4d8c9a3385 Prompt user in `remove`
In order to avoid mistakes, prompt the user when removing records. Allow
skipping of the prompt using the --force option.
2015-03-18 18:20:24 -07:00
William Melody 00e94c8042 Verify write permissions before running write commands
When the user doesn't have write permissions, display a helpful error
message.
2015-03-18 18:02:09 -07:00
William Melody a330d17862 Add `$HOSTS_PATH` variable
This variable makes it possible to configure the hosts path to something
other than /etc/hosts.
2015-03-18 17:47:20 -07:00
William Melody bc36182773 Print disabled matches in `show` 2015-03-18 17:41:04 -07:00
William Melody 522d189f2e Update `help` with latest usage information. 2015-03-18 17:25:34 -07:00
William Melody 10704e2bd7 Use $DEFAULT_COMMAND pattern from bash-boilerplate
This is more verbose, but consistent with bash-boilerplate's approach.
2015-03-18 17:23:15 -07:00
William Melody 8889e26255 Run the `list` command by default when no command is provided 2015-03-18 17:13:25 -07:00
William Melody e9dec32c90 Display disabled records in `list` when present
When disabled records are present, include them in a new section in the
default output of `list`. If no disabled records are present, don't
include the section.
2015-03-18 17:10:21 -07:00
William Melody 7d8a94d4ca Add 'enabled' and 'disabled' options to `list`
These return records that have the status specified in the option.
2015-03-18 17:05:33 -07:00
William Melody 9de0edda07 Add `disable` and `enable` commands
These commands make it possible to disable records without fully
removing them. To 'disable' a record, it simply is commented out with
the following pattern `#disabled: ` prepended to the line.
2015-03-18 16:53:03 -07:00
William Melody 124520efc4 Add `show` command and use that for `list` searches
Displaying a record pair for a hostname or IP address is likely a common
operation, and using the `show` name makes it clear what the primary
function of the command is. Since record pairs are very simple, the
easiest way to allow both hostname and ip address arguments is to use
grep, which also provides general search-like functionality. In order to
avoid doubling this functionality, use the `show` command in the `list`
command for search.
2015-03-18 16:07:49 -07:00
William Melody cdf7793d7e Make `list` search terms match anywhere on the line
Making list more flexible enables searching for hostnames as well as
partial ip addresses.
2015-03-18 16:01:32 -07:00
William Melody a8461f48fd Use alpha ordering for function definitions 2015-03-18 15:45:23 -07:00
William Melody f7ed234951 Expand Readme slightly. 2015-03-16 20:13:19 -07:00
William Melody a52020ed40 Add `hosts file` command to Readme. 2015-03-16 19:56:16 -07:00
William Melody 235be1f151 Expand per-command usage info.
Including descriptions of each command, since the functionality might
not always be immediately obvious.
2015-03-16 19:53:50 -07:00
William Melody bafa955308 Add `file` command
This command simply runs `cat` on /etc/hosts
2015-03-16 19:48:16 -07:00
William Melody 2853d6fd33 Add per-command usage info to program help 2015-03-16 19:38:10 -07:00
William Melody e867492064 In `remove`, delete the link in place rather than blanking first
When using the pattern of blanking the lines first and then deleting
the blank lines, the program ends up deleting potentially intentional
blank lines. In order to avoid this, use a simple delete rather than the
blanking + blank line deleting pattern.
2015-03-16 17:51:28 -07:00
William Melody 7607dfd262 Add `edit` command
`edit` open the hosts file in the editor specified in the $EDITOR
environment variable.
2015-03-16 17:39:50 -07:00
William Melody fc60f3a0d7 Clarify usage information 2015-03-16 17:26:58 -07:00
William Melody f714965f0f Add acknowledgements sections for script and Readme 2015-03-16 17:19:17 -07:00
William Melody 001fcfc959 Add initial Readme with basic information. 2015-03-16 17:08:59 -07:00