Skip to content

Commit f84d2c7

Browse files
committed
docs: updated documentation about TypeScript and ESLint
1 parent c20b7db commit f84d2c7

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,17 +136,17 @@ Then open http://www.example.org/phpmyfaq/setup/ in your browser.
136136

137137
### PHP
138138

139-
To run our unit tests via PHPUnit v12.x, just execute this command on your CLI
139+
To run our unit tests via PHPUnit v12.x, execute this command on your CLI
140140

141141
$ curl -s https://getcomposer.org/installer | php
142142
$ php composer.phar install
143143
$ ./vendor/bin/phpunit
144144

145145
Please note that phpMyFAQ needs to be installed via Composer.
146146

147-
### Javascript
147+
### TypeScript
148148

149-
To run our JavaScript tests via Vitest, just execute this command on your CLI
149+
To run our TypeScript tests via Vitest, execute this command on your CLI
150150

151151
$ curl -fsSL https://get.pnpm.io/install.sh | sh -
152152
$ pnpm install

docs/development.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,14 +229,14 @@ For development purposes, you can start a full stack to run your current phpMyFA
229229

230230
The command above starts nine containers for ^multi-database development as follows.
231231

232-
_Specific images started once to prepare the project:_
232+
_Specific images started at once to prepare the project:_
233233

234234
- **composer**: update Composer dependencies
235235
- **pnpm**: update PNPM dependencies
236236

237237
_Running using named volumes:_
238238

239-
- **mariadb**: image with MariaD B database with xtrabackup support
239+
- **mariadb**: image with MariaDB database with xtrabackup support
240240
- **phpmyadmin**: a PHP tool to have a look on your MariaDB database.
241241
- **postgres**: image with PostgreSQL database
242242
- **pgadmin**: a PHP tool to have a look on your PostgreSQL database.
@@ -292,7 +292,11 @@ To run the PHPUnit-based tests, you can use the following command:
292292

293293
$ composer test
294294

295-
To run the Jest-based tests, you can use the following command:
295+
To run the ESLint-based checks, you can use the following command:
296+
297+
$ pnpm eslint .
298+
299+
To run the Vitest-based tests, you can use the following command:
296300

297301
$ pnpm test
298302

@@ -319,7 +323,7 @@ You can now make a pull request on the phpMyFAQ GitHub repository.
319323

320324
## 8.6 Builtin Twig Extensions
321325

322-
phpMyFAQ v4 and later uses the Twig template engine for the frontend and the backend.
326+
phpMyFAQ v4 and later use the Twig template engine for the frontend and the backend.
323327
We have added some custom extensions to Twig to make it easier to work with phpMyFAQ.
324328

325329
### Category Name Twig Extension

0 commit comments

Comments
 (0)