Brunobkr/llama.cpp_AlgMor24_github

1# vfile-message2 3[![Build][build-badge]][build]4[![Coverage][coverage-badge]][coverage]5[![Downloads][downloads-badge]][downloads]6[![Size][size-badge]][size]7[![Sponsors][sponsors-badge]][collective]8[![Backers][backers-badge]][collective]9[![Chat][chat-badge]][chat]10 11Create [vfile][] messages.12 13## Install14 15[npm][]:16 17```bash18npm install vfile-message19```20 21## Use22 23```js24var VMessage = require('vfile-message')25 26var message = new VMessage(27  '`braavo` is misspelt; did you mean `bravo`?',28  {line: 1, column: 8},29  'spell:typo'30)31 32console.log(message)33```34 35Yields:36 37```js38{ [1:8: `braavo` is misspelt; did you mean `bravo`?]39  reason: '`braavo` is misspelt; did you mean `bravo`?',40  fatal: null,41  line: 1,42  column: 8,43  location:44   { start: { line: 1, column: 8 },45     end: { line: null, column: null } },46  source: 'spell',47  ruleId: 'typo' }48```49 50## API51 52### `VMessage(reason[, position][, origin])`53 54Constructor of a message for `reason` at `position` from `origin`.55When an error is passed in as `reason`, copies the stack.56 57##### Parameters58 59###### `reason`60 61Reason for message (`string` or `Error`).62Uses the stack and message of the error if given.63 64###### `position`65 66Place at which the message occurred in a file ([`Node`][node],67[`Position`][position], or [`Point`][point], optional).68 69###### `origin`70 71Place in code the message originates from (`string`, optional).72 73Can either be the [`ruleId`][ruleid] (`'rule'`), or a string with both a74[`source`][source] and a [`ruleId`][ruleid] delimited with a colon75(`'source:rule'`).76 77##### Extends78 79[`Error`][error].80 81##### Returns82 83An instance of itself.84 85##### Properties86 87###### `reason`88 89Reason for message (`string`).90 91###### `fatal`92 93If `true`, marks associated file as no longer processable (`boolean?`).94If `false`, necessitates a (potential) change.95The value can also be `null` or `undefined`.96 97###### `line`98 99Starting line of error (`number?`).100 101###### `column`102 103Starting column of error (`number?`).104 105###### `location`106 107Full range information, when available ([`Position`][position]).108Has `start` and `end` properties, both set to an object with `line` and109`column`, set to `number?`.110 111###### `source`112 113Namespace of warning (`string?`).114 115###### `ruleId`116 117Category of message (`string?`).118 119###### `stack`120 121Stack of message (`string?`).122 123##### Custom properties124 125It’s OK to store custom data directly on the `VMessage`, some of those are126handled by [utilities][util].127 128###### `file`129 130You may add a `file` property with a path of a file (used throughout the131[**VFile**][vfile] ecosystem).132 133###### `note`134 135You may add a `note` property with a long form description of the message136(supported by [`vfile-reporter`][reporter]).137 138###### `url`139 140You may add a `url` property with a link to documentation for the message.141 142## Contribute143 144See [`contributing.md`][contributing] in [`vfile/.github`][health] for ways to145get started.146See [`support.md`][support] for ways to get help.147 148This project has a [code of conduct][coc].149By interacting with this repository, organization, or community you agree to150abide by its terms.151 152## License153 154[MIT][license] © [Titus Wormer][author]155 156<!-- Definitions -->157 158[build-badge]: https://img.shields.io/travis/vfile/vfile-message.svg159 160[build]: https://travis-ci.org/vfile/vfile-message161 162[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-message.svg163 164[coverage]: https://codecov.io/github/vfile/vfile-message165 166[downloads-badge]: https://img.shields.io/npm/dm/vfile-message.svg167 168[downloads]: https://www.npmjs.com/package/vfile-message169 170[size-badge]: https://img.shields.io/bundlephobia/minzip/vfile-message.svg171 172[size]: https://bundlephobia.com/result?p=vfile-message173 174[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg175 176[backers-badge]: https://opencollective.com/unified/backers/badge.svg177 178[collective]: https://opencollective.com/unified179 180[chat-badge]: https://img.shields.io/badge/chat-spectrum-7b16ff.svg181 182[chat]: https://spectrum.chat/unified/vfile183 184[npm]: https://docs.npmjs.com/cli/install185 186[contributing]: https://github.com/vfile/.github/blob/master/contributing.md187 188[support]: https://github.com/vfile/.github/blob/master/support.md189 190[health]: https://github.com/vfile/.github191 192[coc]: https://github.com/vfile/.github/blob/master/code-of-conduct.md193 194[license]: license195 196[author]: https://wooorm.com197 198[error]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error199 200[node]: https://github.com/syntax-tree/unist#node201 202[position]: https://github.com/syntax-tree/unist#position203 204[point]: https://github.com/syntax-tree/unist#point205 206[vfile]: https://github.com/vfile/vfile207 208[util]: https://github.com/vfile/vfile#utilities209 210[reporter]: https://github.com/vfile/vfile-reporter211 212[ruleid]: #ruleid213 214[source]: #source215