jaid / lines-loader

Webpack loader that loads a text file as an array of its lines.

lines-loader

Webpack loader that loads a text file as an array of its lines.

Usage

Add the loader to your Webpack config:

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.lines\.txt$/,
        use: "lines-loader"
      }
    ]
  }
}

Now you can import corresponding files in your entry script:

index.js

import lines from "./example.lines.txt"

console.log(lines.length)

example.lines.txt

maxine
chloe
rachel

Variable lines in index.js will look like this:

["maxine", "chloe", "rachel"]

Advanced Usage

All options can be set inline. Example:

index.js

import lines from "./example.lines.txt?nonEmpty=false"
import linesNormalized from "./example.lines.txt?sort&unique"

console.log(lines.length)
console.log(linesNormalized.length)

example.lines.txt

maxine
chloe

rachel


chloe

Variable lines in index.js will look like this:

["maxine", "chloe", "", "rachel", "", "", "chloe", ""]

Variable linesNormalized in index.js will look like this:

["chloe", "maxine", "rachel"]

Options

Option	Default	Description
nonEmpty	true	If true, empty lines will be skipped. If option trim is true, any lines that only contain whitespace will be also skipped.
randomPick	false	If true, the exported value will be a function instead of a string[]. That function does not take any arguments an returns a random pick from the extracted lines.
sort	false	If true, extracted lines will be sorted alphabetically.
trim	true	If true, extracted lines' left and right whitespace will be trimmed.
unique	false	If true, there will not be any duplicates in extracted lines.

All options can be overwritten in any asset import by appending a query string.

Installation

npm install --save-dev lines-loader@^2.0.1

yarn add --dev lines-loader@^2.0.1

Development

Setting up:

git clone [email protected]:jaid/lines-loader.git
cd lines-loader
npm install

Testing:

npm run test:dev

Testing in production environment:

npm run test

License

MIT License

Copyright © 2020, Jaid <[email protected]> (github.com/jaid)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.