Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gherking/gpc-remove-comments
This precompiler removes all or particular type of semantic comments from the feature file.
https://github.com/gherking/gpc-remove-comments
cucumber feature-file gherkin gherking gpc hacktoberfest precompiler typescript
Last synced: 18 days ago
JSON representation
This precompiler removes all or particular type of semantic comments from the feature file.
- Host: GitHub
- URL: https://github.com/gherking/gpc-remove-comments
- Owner: gherking
- License: mit
- Created: 2022-03-04T15:51:27.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T04:30:22.000Z (7 months ago)
- Last Synced: 2024-10-29T22:33:15.272Z (2 months ago)
- Topics: cucumber, feature-file, gherkin, gherking, gpc, hacktoberfest, precompiler, typescript
- Language: TypeScript
- Homepage: https://gherking.github.io/gpc-remove-comments/
- Size: 1.1 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gpc-remove-comments
    
This precompiler removes all or particular type of semantic comments from the feature file.
## Usage
```javascript
'use strict';
const compiler = require('gherking');
const { default: RemoveComments, CommentType } = require('gpc-remove-comments');
let ast = await compiler.load('./features/src/login.feature');
ast = compiler.process(
ast,
new RemoveComments({
keep: CommentType.STEP | CommentType.PRECEDING
})
);
await compiler.save('./features/dist/login.feature', ast, {
lineBreak: '\r\n'
});
```
```typescript
'use strict';
import {load, process, save} from "gherking";
import RemoveComments, { CommentType } from "gpc-remove-comments";
let ast = await load("./features/src/login.feature");
ast = process(
ast,
new RemoveComments({
keep: CommentType.STEP | CommentType.PRECEDING
})
);
await save('./features/dist/login.feature', ast, {
lineBreak: '\r\n'
});
```
### Configuration
By default, the precompiler removes all comments. But to keep certain [type of comments](https://github.com/gherking/gherkin-ast#comments), the `keep` configuration options
and the [CommentType](src/types.ts) flags can be used.
- To keep all comments, pass the `CommentType.ALL` in `keep`
- To keep none of the comments, pass the `CommentType.NONE` in `keep` (this is the default)
- To keep any or more types, pass the value using the **binary OR**: `CommentType.STEP | CommentType.TAG`
#### `.gherking.json`
When the configuration is set in the `.gherking.json`, the names of the `CommentType` can be used and passed as a **string array**, e.g.
```json
{
"compilers": [
{
"path": "gpc-remove-comments",
"configuration": {
"keep": ["STEP", "TAG"]
}
}
]
}
```
## Other
This package uses [debug](https://www.npmjs.com/package/debug) for logging, use `gpc:remove-comments` :
```shell
DEBUG=gpc:remove-comments* gherking ...
```
For detailed documentation see the [TypeDocs documentation](https://gherking.github.io/gpc-remove-comments/).