Skip to content

Commit ceb59c4

Browse files
Documented changes and added backtick around snippet prefixes in the documentation
1 parent 37b0e54 commit ceb59c4

File tree

2 files changed

+48
-22
lines changed

2 files changed

+48
-22
lines changed

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,18 @@ Additionally it added the following new snippets:
2727
- main : main
2828
- const : const
2929
- todo : TODO
30+
31+
### [1.0.1]
32+
33+
`forrange` snippet:
34+
Removed the line using the index to reference the index of an array as it is not strictly part of the snippet, `arri` was introduced for that purpose.
35+
36+
Documented the following snippets, that were previously implemented, some of them under different names (name changes reported below):
37+
- `array` : declares an array
38+
- `forarray` -> `forarre` : iterates throught the elements in an array
39+
- `forindex` -> `forrange` : iterates throught a range of indexes
40+
41+
42+
Added the following new snippet:
43+
- `case`: shell case statement
44+
- `arri`: Array indexing statement

README.md

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,22 @@ A collection of bash snippets
66

77
Just a few snippets to make shellscript dev easier
88

9-
- shebang : shebang
10-
- e : echo
11-
- fn : function
12-
- fnd : function with definitions
13-
- if : if
14-
- ife : if else
15-
- elif : elif
16-
- until : until
17-
- main : main
18-
- const : const
19-
- todo : TODO
9+
- `shebang` : shebang
10+
- `e` : echo
11+
- `fn` : function
12+
- `fnd` : function with definitions
13+
- `if` : if
14+
- `ife` : if else
15+
- `elif` : elif
16+
- `until` : until
17+
- `main` : main
18+
- `const` : const
19+
- `todo` : TODO
20+
- `array` : array declaration
21+
- `forarre` : iterates throught the elements in an array
22+
- `forrange` : iterates throught a range of indexes
23+
- `case`: shell case statement
24+
- `arri`: Array indexing statement
2025

2126
## Known Issues
2227

@@ -26,13 +31,13 @@ None
2631

2732
### 0.0.1
2833

29-
- shebang : shebang
30-
- e : echo
31-
- fn : function
32-
- if : if
33-
- ife : if else
34-
- elif : elif
35-
- until : until
34+
- `shebang` : shebang
35+
- `e` : echo
36+
- `fn` : function
37+
- `if` : if
38+
- `ife` : if else
39+
- `elif` : elif
40+
- `until` : until
3641

3742
### 0.0.2
3843

@@ -43,9 +48,15 @@ Added a logo
4348
This release updated the format choice for function names (fn) to align with the [Shell Style Guide](https://google.github.io/styleguide/shellguide.html#function-comments)
4449

4550
Additionally it added the following new snippets:
46-
- fnd : function with definitions
47-
- main : main
48-
- const : const
49-
- todo : TODO
51+
- `fnd` : function with definitions
52+
- `main` : main
53+
- `const` : const
54+
- `todo` : TODO
55+
56+
### 1.0.1
57+
58+
Added the following new snippet:
59+
- `case`: shell case statement
60+
- `arri`: Array indexing statement
5061

5162
**Enjoy!**

0 commit comments

Comments
 (0)