# sequelize-model-comments > Add comments to your Sequelize models. Latest version **0.0.4** (published 2018-04-22) · MIT license · 0 weekly downloads ## Install ```sh npm install sequelize-model-comments pnpm add sequelize-model-comments yarn add sequelize-model-comments bun add sequelize-model-comments ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.4 | | Published | 2018-04-22 | | First published | 2017-10-29 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=5.0.0 | | Dependencies | 2 | | Unpacked size | 21.3 KB | | Known vulnerabilities | 0 (+8 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | Lijo Antony | | Maintainers | lijoantony | | Keywords | sequelize, sequelize-plugin, comments, model comments, nodejs | ## Links - npm: https://www.npmjs.com/package/sequelize-model-comments - Repository: https://github.com/lijoantony/sequelize-model-comments - Homepage: https://github.com/lijoantony/sequelize-model-comments#readme - Issues: https://github.com/lijoantony/sequelize-model-comments/issues - npm.io page: https://npm.io/package/sequelize-model-comments ## Dependencies (2) - [lodash](https://npm.io/package/lodash.md) ^4.11.1 - [sequelize](https://npm.io/package/sequelize.md) ^3.21.0 ## Recent versions - 0.0.4 (latest) — 2018-04-22 - 0.0.3 — 2017-10-31 - 0.0.2 — 2017-10-30 - 0.0.1 — 2017-10-29 ## README # Sequelize Model Comments > Comments support for your sequelize models. Record the user who created the comment. When used along with sequelize-paper-trail, annotates revisions with a user supplied comment. [![node-version](https://img.shields.io/node/v/sequelize-model-comments.svg)](https://www.npmjs.org/package/sequelize-model-comments) [![npm-version](https://img.shields.io/npm/v/sequelize-model-comments.svg)](https://www.npmjs.org/package/sequelize-model-comments) [![David](https://img.shields.io/david/lijoantony/sequelize-model-comments.svg?maxAge=3600)]() [![David](https://img.shields.io/david/dev/lijoantony/sequelize-model-comments.svg?maxAge=3600)]() [![GitHub release](https://img.shields.io/github/release/lijoantony/sequelize-model-comments.svg)](https://www.npmjs.org/package/sequelize-model-comments) [![GitHub tag](https://img.shields.io/github/tag/lijoantony/sequelize-model-comments.svg)](https://www.npmjs.org/package/sequelize-model-comments) [![GitHub commits](https://img.shields.io/github/commits-since/lijoantony/sequelize-model-comments/1.2.0.svg)]() [![npm-downloads](https://img.shields.io/npm/dt/sequelize-model-comments.svg)](https://www.npmjs.org/package/sequelize-model-comments) [![license](https://img.shields.io/github/license/lijoantony/sequelize-model-comments.svg)](https://github.com/lijoantony/sequelize-model-comments/blob/master/LICENSE) ## Table of Contents - [Installation](#installation) - [Usage](#usage) - [Example](#example) - [User Tracking](#user-tracking) - [Options](#options) - [Default options](#default-options) - [Options documentation](#options-documentation) - [Support](#support) - [Contributing](#contributing) - [Author](#author) - [Thanks](#thanks) - [Links](#links) ## Installation ```bash npm install --save sequelize-model-comments ``` *Note: the current test suite is very limited in coverage.* ## Usage Sequelize Model Comments assumes that you have already set up your Sequelize connection, for example, like this: ```javascript var Sequelize = require('sequelize'); var sequelize = new Sequelize('database', 'username', 'password'); ``` then adding Sequelize Model Comments is as easy as: ```javascript var ModelComments = require('sequelize-model-comments').init(sequelize, options); ModelComments.defineModels({}); ``` which loads the Model Comments library, and the `defineModels()` method sets up a `Comments` table. *Note: If you pass `userModel` option to `init` in order to enable user tracking, `userModel` should be setup before `defineModels()` is called.* Then for each model that you want to keep a model comments you simply add: ```javascript Model.enableModelComments(); ``` ### Example ```javascript var Sequelize = require('sequelize'); var sequelize = new Sequelize('database', 'username', 'password'); var ModelComments = require('sequelize-model-comments').init(sequelize, options || {}); ModelComments.defineModels(); var Post = sequelize.define('Post', { title: Sequelize.STRING, content: Sequelize.STRING, }); Post.enableModelComments(); ``` ## User Tracking There are 2 steps to enable user tracking, ie, recording the user who created a comment. 1. Enable user tracking by passing `userModel` option to `init`, with the name of the model which stores users in your application as the value. ```javascript var options = { /* ... */ userModel: 'users', }; ``` 2. Pass the id of the user who is responsible for a database operation to `sequelize-model-comments` by sequelize options. ```javascript Post.update({ /* ... */ comment: 'This attribute will be used to create a comment which annotates the revision' }, { userId: user.id }).then(() { /* ... */ }); ``` ## Options Model Comments supports various options that can be passed into the initialization. The following are the default options: ### Default options ```javascript // Default options var options = { commentModel: 'Comment', UUID: false, underscored: false, underscoredAttributes: false, defaultAttributes: { documentId: 'documentId', model: 'model' }, }; ``` ### Options documentation | Option | Type | Default Value | Description | |-------------------------|---------|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [debug] | Boolean | false | Enables logging to the console. | | [commentModel] | String | 'Comment | Name of the model that keeps the comments. | | [UUID] | Boolean | false | The [commentModel] has id attribute of type UUID for postgresql. | | [underscored] | Boolean | false | The [commentModel] has 'createdAt' and 'updatedAt' attributes, by default, setting this option to true changes it to 'created_at' and 'updated_at'. | | [underscoredAttributes] | Boolean | false | The [commentModel] has a [defaultAttribute] 'documentId' by default, setting this option to true changes it to 'document_id'. | | [defaultAttributes] | Object | { documentId: 'documentId', model: 'model' } | | | [userModel] | String | | Name of the model that stores users in your. | ## Support Please use: * GitHub's [issue tracker](https://github.com/lijoantony/sequelize-model-comments/issues) ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Added some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request ## Author © [Lijo Antony](https://lijoantony.com) – [@lijo_](https://twitter.com/lijo_) – lijozom@gmail.com Distributed under the MIT license. See ``LICENSE`` for more information. [https://github.com/lijoantony/sequelize-model-comments](https://github.com/lijoantony/) ## Thanks This project was inspired by and derived from: * [Sequelize Paper Trail](https://github.com/nielsgl/sequelize-paper-trail) ## Links --- _Source: https://npm.io/package/sequelize-model-comments · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._