Skip to content

Commit c600203

Browse files
author
Polgár Márton
committed
Removing references of CSON from the contribution guide
1 parent 7f4def3 commit c600203

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

CONTRIBUTING.md

+9-15
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,7 @@ Because of this, a priority system is the best way to categorize any issues.
5656
### Atom Grammars
5757

5858
* Atom uses a TextMate type grammar. While TextMate uses plist's(XMLish),
59-
Atom stores them in [CSON][CSON] format.
60-
* In CSON, indentation matters. Don't forget this!
61-
* In CSON the only characters that need to be escaped inside a single quoted
62-
string are single quotes(`'`), backslashes(`\`) and control codes.
59+
Atom stores them in JSON format.
6360
* The code that Atom uses to actually process the grammars is called
6461
[first-mate][first-mate].
6562
* Lines above and below each other that are on the same indentation level
@@ -82,8 +79,8 @@ Because of this, a priority system is the best way to categorize any issues.
8279
TextMate style grammars (Sublime, Atom, TextMate).
8380
* If you want use a hex codepoint instead of typing the symbol in, please use
8481
`\\x{20}` (Unescaped form: `\x{20}`).
85-
This will use the Regex engine for this instead of using the JSON/CSON method
86-
of noting unicode codepoints (e.g. `\u20` which can be used in CSON/JSON).
82+
This will use the Regex engine for this instead of using the JSON method
83+
of noting unicode codepoints (e.g. `\u20` which can be used in JSON).
8784
* Specify Unicode properties like this: `\\p{Alpha}`(`\p{Alpha}` in unescaped
8885
form). See the cheatsheet linked below for all the ones that are guaranteed
8986
to work.
@@ -93,18 +90,16 @@ Because of this, a priority system is the best way to categorize any issues.
9390

9491
* A helpful site to try out Ruby regex is [Rubular][Rubular], although it only
9592
assumes `/…/` regex syntax so you must escape forward slashes. You do not
96-
need to escape forward slashes in the CSON file.
93+
need to escape forward slashes in the JSON file.
9794
* [Regex101](regex101.com) is more graphical and nicer but make
9895
sure to test out the regex on [Rubular][Rubular] once you have it assembled!
9996

10097
## TextMate Grammar Documentation
10198
Reading the [documentation][textmate] for TextMate grammars is informative but
10299
leaves some things unanswered. In this section I will go over the basics.
103100

104-
The CSON file at the top has the patterns which are matched, in order from top
105-
to bottom. As I said in the CSON section, indentation in CSON is significant,
106-
and anything not bracketed above and below each other on the same level of
107-
indentation does not retain order of the elements of the list.
101+
The JSON file at the top has the patterns which are matched, in order from top
102+
to bottom.
108103

109104
### Single line/simple matching
110105
The bottom of the file has named sections which can be 'included' into other
@@ -131,11 +126,11 @@ on top of the previous ones. You list the subrules in the Patterns section
131126
of the rule you are working on.
132127

133128
### Show me the source already!
134-
The majority of the grammar is included in `grammars/raku.cson`.
129+
The majority of the grammar is included in `grammars/raku.tmLanguage.json`.
135130
The `q[]`, `qq[]`, `Q[]`, `"…"` etc. quoting is generated by
136131
`dev/q-qq-Q-template.raku`. Multi-line comments are also generated. The q
137-
types of quoting are added to `raku.quoting.cson`. The standard quotation
138-
marks are added to `raku.cson`.
132+
types of quoting are added to `raku.quoting.tmLanguage.json`. The standard quotation
133+
marks are added to `raku.tmLanguage.json`.
139134

140135
Once you have edited `q-qq-Q-template.raku`, run `dev/replace.sh` which uses
141136
awk to do the replacement. Eventually it will be nice if we had a purely Raku
@@ -158,7 +153,6 @@ error out when you run `apm test` yourself).
158153

159154

160155

161-
[CSON]: https://github.com/bevry/cson
162156
[Rubular]: http://rubular.com/
163157
[Oniguruma]: https://en.wikipedia.org/wiki/Oniguruma
164158
[Oniguruma-RE]: https://github.com/kkos/oniguruma/blob/master/doc/RE

0 commit comments

Comments
 (0)