\n\nConfiguration parser for [Fluent-bit](https://github.com/fluent/fluent-bit)\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n - [How to import](#how-to-import)\n - [Use Cases](#use-cases)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Getting Started\n\nfluent-bit configuration parser will allow you to validate some aspects of fluent-bit configuration.\n\nfor more information about fluent-bit configuration you can visit [fluent-bit website](https://docs.fluentbit.io/manual/administration/configuring-fluent-bit/configuration-file).\n\n### How to import\n\nYou can import the parser as follows:\n\n```typescript\nimport { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';\n```\n\nThis library offers a couple of methods:\n\n`schema`: it will return the parsed configuration as a fluent-bit schema.\n\n`toString()`: it will return the parsed schema, back to a string\n\n`source`: it will return the config as it was provided.\n\n`FluentBitSchema.isFluentBitConfiguration`: A static method, to validate if the configuration is fluentBit. It's important to notice, that this method, will not confirm if the provided config is valid. For that please see below:\n\n## Use cases.\n\n### I have a file, but I'm not sure if is fluent-bit or Fluentd:\n\n```typescript\nimport fs from 'fs';\n\nimport { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';\n\nconst filePath = '/path/to/file.conf';\nconst file = fs.readFileSync(filePath, { encoding: 'utf-8' });\n\nconsole.log(FluentBitSchema.isFluentBitConfiguration(file)); // => true/false\n```\n\n### I want to confirm if my `fluent-bit` configuration is valid:\n\n```typescript\nimport fs from 'fs';\n\nimport { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';\n\nconst filePath = '/path/to/file.conf';\nconst file = fs.readFileSync(filePath, { encoding: 'utf-8' });\n\ntry {\n const config = new FluentBitSchema(file);\n console.log('yay! my configuration is valid');\n} catch (e) {\n console.log(e.message); // this message will provide some insight int what went wrong.\n}\n```\n\n### I would like to re-format my configuration.\n\n```typescript\nimport fs from 'fs';\n\nimport { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';\n\nconst filePath = '/path/to/file.conf';\n\nconst file = fs.readFileSync(filePath, { encoding: 'utf-8' });\n\nconst config = new FluentBitSchema(file, filePath);\n\nconsole.log(config.toString());\n```\n\n### Options\n\nFluentBitSchema can handle directives such as @SET and @INCLUDE. That's why the second argument is a `filePath`. Sometimes the configuration we create has full paths. These paths will most likely change when placing them in a repository. If that's your case, you can set `ignoreFullPaths: true` and the parser will ignore @INCLUDES containing full paths. One handy example of this could be:\n\n```typescript\nimport fs from 'fs';\n\nimport { FluentBitSchema } from '@calyptia/fluent-bit-config-parser';\n\nconst filePath = '/path/to/file.conf';\n\nconst rawConfig = `\n@INCLUDE /this/is/a/full/path/that/does/not/exist/in/my/repo/config.conf\n\n[INPUT]\n name dummy\n`;\n\nconst file = fs.readFileSync(filePath, { encoding: 'utf-8' });\n\nconst config = new FluentBitSchema(file, filePath, { ignoreFullPaths: true });\n\nconsole.log(config.toString()); // will not contain the @INCLUDE directive call.\n```\n\n\n\n## Contributing\n\nContributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n","readmeFilename":"README.md"}
![\"Linting\"](\"https://github.com/calyptia/fluent-bit-config-parser/actions/workflows/linting.yml/badge.svg\"){kind=icon}
\n \n \n ![\"unit-tests\"](\"https://github.com/calyptia/fluent-bit-config-parser/actions/workflows/unit-tests.yml/badge.svg\"){kind=icon}
\n \n \n ![\"codecov\"](\"https://codecov.io/gh/calyptia/fluent-bit-config-parser/branch/main/graph/badge.svg?token=48gHuQl8zV\"){kind=icon}
\n \n \n ![\"APACHE](\"https://img.shields.io/github/license/calyptia/fluent-bit-config-parser\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/v/@calyptia/fluent-bit-config-parser\")
\n \n \n![\"Logo\"](\"images/logo.png\"){kind=logo}
\n \n\n