knex 0.21.20 → 0.21.21

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Master (Unreleased)
 
+# 0.21.21 - 10 August, 2021
+
+### Bug fixes:
+
+- CLI: Fix line terminators causing knex migrations to fail
+
 # 0.21.20 - 07 August, 2021
 
 ### Typings:

package/CONTRIBUTING.md

@@ -1,184 +1,184 @@
-## How to contribute to Knex.js
-
-- Make changes in the `/lib` directory. 
-
-- Before sending a pull request for a feature or bug fix, be sure to have
-  [tests](https://github.com/knex/knex/tree/master/test). Every pull request that changes the queries should have
-  also **integration tests which are ran against real database** (in addition to unit tests which checks which kind of queries
-  are being created).
-
-- Use the same coding style as the rest of the
-  [codebase](https://github.com/knex/knex/blob/master/knex.js).
-
-- All pull requests should be made to the `master` branch.
-
-- Pull request description should have link to corresponding PR of documentation branch.
-
-- All pull requests that modify the public API should be updated in [types/index.d.ts](https://github.com/knex/knex/blob/master/types/index.d.ts)
-
-## Documentation
-
-Documentation is no longer maintained in knex master repository. All the documentation pull requests should be sent to https://github.com/knex/documentation
-
-Documentation pull requests should not be merged before knex version which has the new documented feature is released.
-
-## I would like to add support for new dialect to knex, is it possible?
-
-Currently there are already way too many dialects supported in `knex` and instead of adding new dialect to central codebase, all the dialects should be moved to separate npm packages out from `knex` core library with their respective maintainers and test suites.
-
-So if you like to write your own dialect, you can just inherit own dialect from knex base classes and use it by passing dialect to knex in knex configuration (https://runkit.com/embed/90b3cpyr4jh2):
-
-```js
-// simple dialect overriding sqlite3 dialect to use sqlite3-offline driver
-require('sqlite3-offline');
-const Knex = require('knex');
-
-const Dialect = require(`knex/lib/dialects/sqlite3/index.js`);
-Dialect.prototype._driver = () => require('sqlite3-offline');
-
-const knex = Knex({
-  client: Dialect,
-  connection: ':memory:',
-});
-
-console.log(knex.select(knex.raw(1)).toSQL());
-
-await knex.schema.createTable('fooobar', (t) => {
-  t.bigincrements('id');
-  t.string('data');
-});
-await knex('fooobar').insert({ data: 'nomnom' });
-
-console.log('Gimme all the data:', await knex('fooobar'));
-```
-
-## What is minimal code to reproduce bug and why I have to provide that when I can just tell whats the problem is
-
-Writing minimal reproduction code for the problem is time-consuming and sometimes it is also really hard, for
-example when the original code where the bug happens is written using express or mocha. So why is it necessary
-for me to commit so much time to it when the problem is in `knex`? Contributors should be grateful that I reported
-the bug I found.
-
-The point of runnable code to reproduce the problem is to easily verify that there really is a problem and that the one
-who did the report did nothing wrong (surprisingly often problem is in the user code). So instead of just description
-what to do the complete code encourages devs to actually test out that problem exists and start solving it and it
-saves lots of time.
-
-tl;dr list:
-
-1. Actually in most of the cases developer already figures out what was the problem when writing the minimal test case
-   or if there was problem how stuff was initialized or how async code was written it is easy to point out the problem.
-
-2. It motivates developer to actually try out if the bug really exist by not having to figure out from incomplete example
-   environment in which and how bug actually manifests.
-
-3. There are currently very few people fixing knex issues and if one has to put easily 15-30 minutes time to issue just
-   to see that I cannot reproduce this issue it just wastes development hours that were available for improving knex.
-
-Test case should initialize needed tables, insert needed data and fail...
-
-```
-const knex = require('knex')({
-  client: 'pg',
-  connection: 'postgres:///knex_test'
-});
-
-async function main() {
-  await knex.schema.createTable(...);
-  await knex('table').insert({foo: 'bar}');
-  await knex.destroy();
-}
-
-main();
-```
-
-Usually issues without reproduction code available are just closed and if the same issue is reported multiple
-times maybe someone looks into it.
-
-One easy way to setup database for your reproduction is to use database from knex's docker-compose setup (npm run db:start) and by checking the connection settings from tests' `test/knexfile.js`.
-
-## Integration Tests
-
-### The Easy Way
-
-By default, Knex runs tests against sqlite3, postgresql, mysql, mysql2, mssql and oracledb drivers. All databases can be initialized and ran with docker.
-
-Docker databases can be started and initialized and started with:
-
-```bash
-npm run db:start
-```
-
-and stopped with:
-
-```bash
-npm run db:stop
-```
-
-In case you don't need all of the databases, you can use simplified dev Docker configuration that only runs PostgreSQL, by running `npm run db:start:postgres` and `npm run db:stop:postgres` accordingly.
-
-### Installing support for oracledb
-
-Oracle has started providing precompiled driver libs for all the platforms, which makes it viable to run oracle tests also locally against oracledb running in docker.
-
-Check message when running
-
-```bash
-npm install oracledb
-```
-
-and download driver library binary packages and unzip it to ~/lib directory.
-
-### Specifying Databases
-
-You can optionally specify which dialects to test using the `DB` environment variable. Values should be space separated and can include:
-
-- mysql
-- mysql2
-- postgres
-- sqlite3
-- oracledb
-- mssql
-
-```bash
-$ DB='postgres mysql' npm test
-```
-
-### Custom Configuration
-
-If you'd like to override the database configuration (to use a different host, for example), you can override the path to the [default test configuration](https://github.com/knex/knex/blob/master/test/knexfile.js) using the `KNEX_TEST` environment variable.
-
-```bash
-$ KNEX_TEST='./path/to/my/config.js' npm test
-```
-
-### Creating Postgres User
-
-If you are running tests against own local database one might need to setup test user and database for knex to connect.
-
-To create a new user, login to Postgres and use the following queries to add the user. This assumes you've already created the `knex_test` database.
-
-```
-CREATE ROLE postgres WITH LOGIN PASSWORD '';
-GRANT ALL PRIVILEGES ON DATABASE "knex_test" TO postgres;
-```
-
-Once this is done, check it works by attempting to login:
-
-```
-psql -h localhost -U postgres -d knex_test
-```
-
-## Want to be Collaborator?
-
-There is always room for more collaborators. Be active on resolving github issues / sending pull requests / reviewing code and we will ask you to join.
-
-### Etiquette (/ˈɛtᵻkɛt/ or /ˈɛtᵻkɪt/, French: [e.ti.kɛt])
-
-Make pull requests for your changes, do not commit directly to master (release stuff like fixing changelog are ok though).
-
-All the pull requests must be peer reviewed by other collaborator, so don't merge your request before that. If there is no response ping others.
-
-If you are going to add new feature to knex (not just a bugfix) it should be discussed first with others to agree on details.
-
-Join Gitter chat if you feel to chat outside of github issues.
+## How to contribute to Knex.js
+
+- Make changes in the `/lib` directory. 
+
+- Before sending a pull request for a feature or bug fix, be sure to have
+  [tests](https://github.com/knex/knex/tree/master/test). Every pull request that changes the queries should have
+  also **integration tests which are ran against real database** (in addition to unit tests which checks which kind of queries
+  are being created).
+
+- Use the same coding style as the rest of the
+  [codebase](https://github.com/knex/knex/blob/master/knex.js).
+
+- All pull requests should be made to the `master` branch.
+
+- Pull request description should have link to corresponding PR of documentation branch.
+
+- All pull requests that modify the public API should be updated in [types/index.d.ts](https://github.com/knex/knex/blob/master/types/index.d.ts)
+
+## Documentation
+
+Documentation is no longer maintained in knex master repository. All the documentation pull requests should be sent to https://github.com/knex/documentation
+
+Documentation pull requests should not be merged before knex version which has the new documented feature is released.
+
+## I would like to add support for new dialect to knex, is it possible?
+
+Currently there are already way too many dialects supported in `knex` and instead of adding new dialect to central codebase, all the dialects should be moved to separate npm packages out from `knex` core library with their respective maintainers and test suites.
+
+So if you like to write your own dialect, you can just inherit own dialect from knex base classes and use it by passing dialect to knex in knex configuration (https://runkit.com/embed/90b3cpyr4jh2):
+
+```js
+// simple dialect overriding sqlite3 dialect to use sqlite3-offline driver
+require('sqlite3-offline');
+const Knex = require('knex');
+
+const Dialect = require(`knex/lib/dialects/sqlite3/index.js`);
+Dialect.prototype._driver = () => require('sqlite3-offline');
+
+const knex = Knex({
+  client: Dialect,
+  connection: ':memory:',
+});
+
+console.log(knex.select(knex.raw(1)).toSQL());
+
+await knex.schema.createTable('fooobar', (t) => {
+  t.bigincrements('id');
+  t.string('data');
+});
+await knex('fooobar').insert({ data: 'nomnom' });
+
+console.log('Gimme all the data:', await knex('fooobar'));
+```
+
+## What is minimal code to reproduce bug and why I have to provide that when I can just tell whats the problem is
+
+Writing minimal reproduction code for the problem is time-consuming and sometimes it is also really hard, for
+example when the original code where the bug happens is written using express or mocha. So why is it necessary
+for me to commit so much time to it when the problem is in `knex`? Contributors should be grateful that I reported
+the bug I found.
+
+The point of runnable code to reproduce the problem is to easily verify that there really is a problem and that the one
+who did the report did nothing wrong (surprisingly often problem is in the user code). So instead of just description
+what to do the complete code encourages devs to actually test out that problem exists and start solving it and it
+saves lots of time.
+
+tl;dr list:
+
+1. Actually in most of the cases developer already figures out what was the problem when writing the minimal test case
+   or if there was problem how stuff was initialized or how async code was written it is easy to point out the problem.
+
+2. It motivates developer to actually try out if the bug really exist by not having to figure out from incomplete example
+   environment in which and how bug actually manifests.
+
+3. There are currently very few people fixing knex issues and if one has to put easily 15-30 minutes time to issue just
+   to see that I cannot reproduce this issue it just wastes development hours that were available for improving knex.
+
+Test case should initialize needed tables, insert needed data and fail...
+
+```
+const knex = require('knex')({
+  client: 'pg',
+  connection: 'postgres:///knex_test'
+});
+
+async function main() {
+  await knex.schema.createTable(...);
+  await knex('table').insert({foo: 'bar}');
+  await knex.destroy();
+}
+
+main();
+```
+
+Usually issues without reproduction code available are just closed and if the same issue is reported multiple
+times maybe someone looks into it.
+
+One easy way to setup database for your reproduction is to use database from knex's docker-compose setup (npm run db:start) and by checking the connection settings from tests' `test/knexfile.js`.
+
+## Integration Tests
+
+### The Easy Way
+
+By default, Knex runs tests against sqlite3, postgresql, mysql, mysql2, mssql and oracledb drivers. All databases can be initialized and ran with docker.
+
+Docker databases can be started and initialized and started with:
+
+```bash
+npm run db:start
+```
+
+and stopped with:
+
+```bash
+npm run db:stop
+```
+
+In case you don't need all of the databases, you can use simplified dev Docker configuration that only runs PostgreSQL, by running `npm run db:start:postgres` and `npm run db:stop:postgres` accordingly.
+
+### Installing support for oracledb
+
+Oracle has started providing precompiled driver libs for all the platforms, which makes it viable to run oracle tests also locally against oracledb running in docker.
+
+Check message when running
+
+```bash
+npm install oracledb
+```
+
+and download driver library binary packages and unzip it to ~/lib directory.
+
+### Specifying Databases
+
+You can optionally specify which dialects to test using the `DB` environment variable. Values should be space separated and can include:
+
+- mysql
+- mysql2
+- postgres
+- sqlite3
+- oracledb
+- mssql
+
+```bash
+$ DB='postgres mysql' npm test
+```
+
+### Custom Configuration
+
+If you'd like to override the database configuration (to use a different host, for example), you can override the path to the [default test configuration](https://github.com/knex/knex/blob/master/test/knexfile.js) using the `KNEX_TEST` environment variable.
+
+```bash
+$ KNEX_TEST='./path/to/my/config.js' npm test
+```
+
+### Creating Postgres User
+
+If you are running tests against own local database one might need to setup test user and database for knex to connect.
+
+To create a new user, login to Postgres and use the following queries to add the user. This assumes you've already created the `knex_test` database.
+
+```
+CREATE ROLE postgres WITH LOGIN PASSWORD '';
+GRANT ALL PRIVILEGES ON DATABASE "knex_test" TO postgres;
+```
+
+Once this is done, check it works by attempting to login:
+
+```
+psql -h localhost -U postgres -d knex_test
+```
+
+## Want to be Collaborator?
+
+There is always room for more collaborators. Be active on resolving github issues / sending pull requests / reviewing code and we will ask you to join.
+
+### Etiquette (/ˈɛtᵻkɛt/ or /ˈɛtᵻkɪt/, French: [e.ti.kɛt])
+
+Make pull requests for your changes, do not commit directly to master (release stuff like fixing changelog are ok though).
+
+All the pull requests must be peer reviewed by other collaborator, so don't merge your request before that. If there is no response ping others.
+
+If you are going to add new feature to knex (not just a bugfix) it should be discussed first with others to agree on details.
+
+Join Gitter chat if you feel to chat outside of github issues.

package/LICENSE

@@ -1,22 +1,22 @@
-Copyright (c) 2013-present Tim Griesser
-
-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.
+Copyright (c) 2013-present Tim Griesser
+
+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.

package/README.md

@@ -1,95 +1,95 @@
-# [knex.js](http://knexjs.org)
-
-[![npm version](http://img.shields.io/npm/v/knex.svg)](https://npmjs.org/package/knex)
-[![npm downloads](https://img.shields.io/npm/dm/knex.svg)](https://npmjs.org/package/knex)
-![](https://github.com/knex/knex/workflows/CI/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/knex/knex/badge.svg?branch=master)](https://coveralls.io/r/knex/knex?branch=master)
-[![Dependencies Status](https://david-dm.org/knex/knex.svg)](https://david-dm.org/knex/knex)
-[![Gitter chat](https://badges.gitter.im/tgriesser/knex.svg)](https://gitter.im/tgriesser/knex)
-[![Language Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/knex/knex.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/knex/knex/context:javascript)
-
-> **A SQL query builder that is _flexible_, _portable_, and _fun_ to use!**
-
-A batteries-included, multi-dialect (MSSQL, MySQL, PostgreSQL, SQLite3, Oracle (including Oracle Wallet Authentication)) query builder for
-Node.js, featuring:
-
-- [transactions](http://knexjs.org/#Transactions)
-- [connection pooling](http://knexjs.org/#Installation-pooling)
-- [streaming queries](http://knexjs.org/#Interfaces-Streams)
-- both a [promise](http://knexjs.org/#Interfaces-Promises) and [callback](http://knexjs.org/#Interfaces-Callbacks) API
-- a [thorough test suite](https://travis-ci.org/knex/knex)
-- the ability to [run in the Browser](http://knexjs.org/#Installation-browser)
-
-Node.js versions 10+ are supported.
-
-[Read the full documentation to get started!](http://knexjs.org)  
-[Or check out our Recipes wiki to search for solutions to some specific problems](https://github.com/knex/knex/wiki/Recipes)  
-If upgrading from older version, see [Upgrading instructions](https://github.com/knex/knex/blob/master/UPGRADING.md)
-
-For support and questions, join the `#bookshelf` channel on freenode IRC
-
-For an Object Relational Mapper, see:
-
-- http://bookshelfjs.org
-- https://github.com/Vincit/objection.js
-
-To see the SQL that Knex will generate for a given query, see: [Knex Query Lab](https://michaelavila.com/knex-querylab/)
-
-## Examples
-
-We have several examples [on the website](http://knexjs.org). Here is the first one to get you started:
-
-```js
-const knex = require('knex')({
-  client: 'sqlite3',
-  connection: {
-    filename: './data.db',
-  },
-});
-
-// Create a table
-knex.schema
-  .createTable('users', table => {
-    table.increments('id');
-    table.string('user_name');
-  })
-
-  // ...and another
-  .createTable('accounts', table => {
-    table.increments('id');
-    table.string('account_name');
-    table
-      .integer('user_id')
-      .unsigned()
-      .references('users.id');
-  })
-
-  // Then query the table...
-  .then(() =>
-    knex('users').insert({ user_name: 'Tim' })
-  )
-
-  // ...and using the insert id, insert into the other table.
-  .then(rows => 
-    knex('accounts').insert({ account_name: 'knex', user_id: rows[0] })
-  )
-
-  // Query both of the rows.
-  .then(() => 
-    knex('users')
-      .join('accounts', 'users.id', 'accounts.user_id')
-      .select('users.user_name as user', 'accounts.account_name as account')
-  )
-
-  // map over the results
-  .then(rows =>
-    rows.map(row => {
-      console.log(row)
-    })
-  )
-
-  // Finally, add a .catch handler for the promise chain
-  .catch(e => {
-    console.error(e);
-  });
-```
+# [knex.js](http://knexjs.org)
+
+[![npm version](http://img.shields.io/npm/v/knex.svg)](https://npmjs.org/package/knex)
+[![npm downloads](https://img.shields.io/npm/dm/knex.svg)](https://npmjs.org/package/knex)
+![](https://github.com/knex/knex/workflows/CI/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/knex/knex/badge.svg?branch=master)](https://coveralls.io/r/knex/knex?branch=master)
+[![Dependencies Status](https://david-dm.org/knex/knex.svg)](https://david-dm.org/knex/knex)
+[![Gitter chat](https://badges.gitter.im/tgriesser/knex.svg)](https://gitter.im/tgriesser/knex)
+[![Language Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/knex/knex.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/knex/knex/context:javascript)
+
+> **A SQL query builder that is _flexible_, _portable_, and _fun_ to use!**
+
+A batteries-included, multi-dialect (MSSQL, MySQL, PostgreSQL, SQLite3, Oracle (including Oracle Wallet Authentication)) query builder for
+Node.js, featuring:
+
+- [transactions](http://knexjs.org/#Transactions)
+- [connection pooling](http://knexjs.org/#Installation-pooling)
+- [streaming queries](http://knexjs.org/#Interfaces-Streams)
+- both a [promise](http://knexjs.org/#Interfaces-Promises) and [callback](http://knexjs.org/#Interfaces-Callbacks) API
+- a [thorough test suite](https://travis-ci.org/knex/knex)
+- the ability to [run in the Browser](http://knexjs.org/#Installation-browser)
+
+Node.js versions 10+ are supported.
+
+[Read the full documentation to get started!](http://knexjs.org)  
+[Or check out our Recipes wiki to search for solutions to some specific problems](https://github.com/knex/knex/wiki/Recipes)  
+If upgrading from older version, see [Upgrading instructions](https://github.com/knex/knex/blob/master/UPGRADING.md)
+
+For support and questions, join the `#bookshelf` channel on freenode IRC
+
+For an Object Relational Mapper, see:
+
+- http://bookshelfjs.org
+- https://github.com/Vincit/objection.js
+
+To see the SQL that Knex will generate for a given query, see: [Knex Query Lab](https://michaelavila.com/knex-querylab/)
+
+## Examples
+
+We have several examples [on the website](http://knexjs.org). Here is the first one to get you started:
+
+```js
+const knex = require('knex')({
+  client: 'sqlite3',
+  connection: {
+    filename: './data.db',
+  },
+});
+
+// Create a table
+knex.schema
+  .createTable('users', table => {
+    table.increments('id');
+    table.string('user_name');
+  })
+
+  // ...and another
+  .createTable('accounts', table => {
+    table.increments('id');
+    table.string('account_name');
+    table
+      .integer('user_id')
+      .unsigned()
+      .references('users.id');
+  })
+
+  // Then query the table...
+  .then(() =>
+    knex('users').insert({ user_name: 'Tim' })
+  )
+
+  // ...and using the insert id, insert into the other table.
+  .then(rows => 
+    knex('accounts').insert({ account_name: 'knex', user_id: rows[0] })
+  )
+
+  // Query both of the rows.
+  .then(() => 
+    knex('users')
+      .join('accounts', 'users.id', 'accounts.user_id')
+      .select('users.user_name as user', 'accounts.account_name as account')
+  )
+
+  // map over the results
+  .then(rows =>
+    rows.map(row => {
+      console.log(row)
+    })
+  )
+
+  // Finally, add a .catch handler for the promise chain
+  .catch(e => {
+    console.error(e);
+  });
+```