Skip to content

Commit 78f5d2f

Browse files
committed
Fixup readme, package-lock, and CI naming
1 parent 98a6958 commit 78f5d2f

File tree

4 files changed

+40
-21
lines changed

4 files changed

+40
-21
lines changed

.github/workflows/tests.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
name: CI
1+
name: tests
22
env:
33
DB_USER: session_test
44
DB_PASS: session_test
55
DB_NAME: session_test
66
on:
77
push:
88
jobs:
9-
ci:
9+
tests:
1010
runs-on: ubuntu-latest
1111
strategy:
1212
matrix:

package-lock.json

+33-11
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

readme.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ A MySQL session store for [express.js](http://expressjs.com/). Compatible with [
66

77
* [Installation](#installation)
88
* [Important Notes](#important-notes)
9-
* [Older Versions](#older-versions)
109
* [Session Table Collation](#session-table-collation)
1110
* [Usage](#usage)
12-
* [With an existing MySQL connection or pool](#with-an-existing-mysql-connection-or-pool)
11+
* [Use an existing MySQL connection or pool](#use-an-existing-mysql-connection-or-pool)
1312
* [Closing the session store](#closing-the-session-store)
1413
* [Options](#options)
1514
* [Custom database table schema](#custom-database-table-schema)
@@ -178,7 +177,7 @@ const options = {
178177
schema: {
179178
tableName: 'custom_sessions_table_name',
180179
columnNames: {
181-
session_id: 'custom_session_id',
180+
session_id: 'custom_session_id_column_name',
182181
expires: 'custom_expires_column_name',
183182
data: 'custom_data_column_name'
184183
}
@@ -191,14 +190,12 @@ const sessionStore = new MySQLStore(options);
191190

192191
### Debugging
193192

194-
`express-mysql-session` uses the [debug module](https://github.com/visionmedia/debug) to output debug messages to the console. To output all debug messages, run your node app with the `DEBUG` environment variable:
193+
`express-mysql-session` uses the [debug module](https://github.com/debug-js/debug) to output debug messages to the console. To output all debug messages, run your node app with the `DEBUG` environment variable:
195194
```
196195
DEBUG=express-mysql-session* node your-app.js
197196
```
198197
This will output log messages as well as error messages from `express-mysql-session`.
199198

200-
If you also might need MySQL-related debug and error messages, see [debugging node-mysql](https://github.com/mysqljs/mysql#debugging-and-reporting-problems).
201-
202199

203200
## Contributing
204201

@@ -227,7 +224,7 @@ git clone https://github.com/chill117/express-mysql-session.git
227224

228225
Second, you'll need to install the project dependencies as well as the dev dependencies. To do this, simply run the following from the directory you created in step 1:
229226
```bash
230-
npm install
227+
npm ci
231228
```
232229

233230
#### Step 3: Set Up the Test Database

test/unit/clearExpiredSessions.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ const assert = require('assert');
22
const manager = require('../manager');
33
const fixtures = manager.fixtures.sessions;
44

5-
describe('clearExpiredSessions(cb)', function() {
5+
describe('clearExpiredSessions()', function() {
66

77
before(manager.setUp);
88
before(manager.populateSessions);

0 commit comments

Comments
 (0)