Registry / database / pg-minify-webpack-loader

pg-minify-webpack-loader

JSON →
library0.3.0jsnpmunverified

Webpack loader that imports SQL files and optionally minifies them using pg-minify. Current version 0.3.0 (stable, last released 2018). Allows importing .sql files directly into webpack bundles with ES6 or CommonJS modules and configurable compression. Useful for Node.js projects using PostgreSQL, as a replacement for raw-loader.

npm install pg-minify-webpack-loader
INSTALL
IMPORT
SIG · PG-MINIFY-WEBPACK-
P
pg-minify-webpack-loader
databasejavascriptv0.3.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

default export (string)
import sql from './file.sql';
const sql = require('./file.sql');
Requires resolve.extensions to include .sql. CommonJS users need module:'commonjs' option or use .default.
CommonJS require with default
const sql = require('./file.sql').default;
const sql = require('./file.sql');
Default module output is ES6; require returns a module object with .default property unless module:'commonjs' is used.
TypeScript module declaration
declare module '*.sql' { var _: string; export default _; }
Required in a .d.ts file for TypeScript type checking.

Imports and minifies a SQL file via webpack loader. Shows webpack config, SQL input, and usage.

// webpack.config.js module.exports = { module: { rules: [ { test: /\.sql$/, use: 'pg-minify-webpack-loader' } ] }, resolve: { extensions: ['.sql'] } }; // query.sql SELECT * FROM users WHERE id = $1; // index.js import query from './query.sql'; console.log(query); // 'SELECT * FROM users WHERE id=$1'
Debug
Known issues
gotcharesolve.extensions must include '.sql' otherwise webpack cannot resolve SQL imports.
fix
Add '.sql' to resolve.extensions in webpack config.
affects: >=0.0.0
gotchaWhen module='es6' (default), CommonJS require returns an object with .default property.
fix
Use require('./file.sql').default or set module:'commonjs'.
affects: >=0.0.0
gotchaTypeScript users must declare a module for .sql files to avoid type errors.
fix
Add declare module '*.sql' { var _: string; export default _; } in a .d.ts file.
affects: >=0.0.0
deprecatedUsing 'loader' key instead of 'use' is deprecated in webpack 4+.
fix
Use 'use' property in rules.
affects: >=0.0.0
Errors
Common errors & fixes
Module not found: Error: Can't resolve './file.sql' in ...
Missing '.sql' extension in resolve.extensions.
fix
Add resolve.extensions: ['.sql'] to webpack config.
TypeError: Cannot read property 'default' of undefined
Using CommonJS require without .default when module='es6'.
fix
Use require('./file.sql').default or set module:'commonjs'.
Cannot find module 'pg-minify'
pg-minify is a peer dependency not automatically installed.
fix
Run 'npm install --save-dev pg-minify'.
Upgrade
Version history
0.3.0latest on npm
Audit
Dependencies
pg-minifyrequiredcore minification engine
Agent activity
4 hits · last 30 days
node
4
Resources
pg-minify-webpack-loader — npm install pg-minify-webpack-loader · libregistry