doc: Macros for common library references
* doc/hacking.texi (Hacking): Use mocha, chai, easejs macros. * doc/macros.texi (mocha, chai, easejs): New macros.master
parent
b74aa64ae8
commit
f0a469944f
|
@ -19,12 +19,10 @@ This chapter provides general information and guidance for
|
||||||
@dnindex Mocha
|
@dnindex Mocha
|
||||||
@dnindex Chai
|
@dnindex Chai
|
||||||
For writing classes; interfaces; and traits,
|
For writing classes; interfaces; and traits,
|
||||||
developers should familiarize themselves with
|
developers should familiarize themselves with @easejs{}.
|
||||||
@url{https://gnu.org/software/easejs,GNU ease.js}.
|
|
||||||
For writing unit tests,
|
For writing unit tests,
|
||||||
developers should be familiarize themselves with
|
developers should be familiarize themselves with
|
||||||
@url{https://mochajs.org/,Mocha} and
|
@mocha{} and @chai{}.
|
||||||
@url{http://www.chaijs.com/,Chai}.
|
|
||||||
For more information on the libraries used by Liza,
|
For more information on the libraries used by Liza,
|
||||||
see @ref{Libraries}.
|
see @ref{Libraries}.
|
||||||
|
|
||||||
|
@ -55,7 +53,7 @@ They further introduce maintenance obligations for keeping up with
|
||||||
JavaScript does not natively support the classical object-oriented
|
JavaScript does not natively support the classical object-oriented
|
||||||
model familiar to users of more traditional classical
|
model familiar to users of more traditional classical
|
||||||
object-oriented languages like Java, C++, C#, and@tie{}PHP.
|
object-oriented languages like Java, C++, C#, and@tie{}PHP.
|
||||||
Liza is built using @url{https://gnu.org/software/easejs,GNU ease.js},
|
Liza is built using @easejs{},
|
||||||
which provides those familiar features.
|
which provides those familiar features.
|
||||||
The primary language used by developers in the office that created
|
The primary language used by developers in the office that created
|
||||||
Liza is@tie{}PHP,
|
Liza is@tie{}PHP,
|
||||||
|
@ -74,9 +72,8 @@ The @code{class} keyword introduced in ECMAScript@tie{} is largely
|
||||||
@subsection Testing Libraries
|
@subsection Testing Libraries
|
||||||
@dnindex Mocha
|
@dnindex Mocha
|
||||||
@dnindex Chai
|
@dnindex Chai
|
||||||
@url{https://mochajs.org/,Mocha} is used as the test runner for
|
@mocha{} is used as the test runner for JavaScript unit tests.
|
||||||
JavaScript unit tests.
|
@chai{} is the assertion library.
|
||||||
@url{http://www.chaijs.com/,Chai} is the assertion library.
|
|
||||||
This differs from PHP development where a single system (PHPUnit)
|
This differs from PHP development where a single system (PHPUnit)
|
||||||
encompasses both of these needs.
|
encompasses both of these needs.
|
||||||
|
|
||||||
|
|
|
@ -248,3 +248,17 @@ See `\ref\' @proguicrefsuffix
|
||||||
@macro proguicrefsuffix{}
|
@macro proguicrefsuffix{}
|
||||||
in the Liza Program@tie{}UI Compiler manual
|
in the Liza Program@tie{}UI Compiler manual
|
||||||
@end macro
|
@end macro
|
||||||
|
|
||||||
|
|
||||||
|
@c common links
|
||||||
|
@macro mocha{}
|
||||||
|
@url{https://mochajs.org/,Mocha}
|
||||||
|
@end macro
|
||||||
|
|
||||||
|
@macro chai{}
|
||||||
|
@url{http://www.chaijs.com/,Chai}
|
||||||
|
@end macro
|
||||||
|
|
||||||
|
@macro easejs{}
|
||||||
|
@url{https://www.gnu.org/software/easejs,GNU ease.js}
|
||||||
|
@end macro
|
||||||
|
|
Loading…
Reference in New Issue