Skip to content

public / sequelize

Go to a project

不要怂，就是干，撸起袖子干！

Commit 1ce34286 by Sushant
Options

chores(docs): upgrade to esdocs@1.1.0

1 parent 56d5feeb
Inline Side-by-side
Showing with 84 additions and 264 deletions
.esdoc.json
{
"title": " Sequelize | The node.js ORM for PostgreSQL, MySQL, SQLite and MSSQL",
"source": "./lib",
"destination": "./esdoc",
"access": ["public"],
"builtinExternal": false,
"unexportIdentifier": true,
"undocumentIdentifier": false,
"includeSource": false,
"coverage": false,
"lint": false,
"includes": ["\\.js$"],
"plugins": [
{"name": "./docs/plugins/esdoc-sequelize.js"}
],
"styles": [
"./docs/css/style.css",
"./docs/css/theme.css"
],
"scripts": [
"./docs/scripts/script.js"
],
"manual": {
"globalIndex": true,
"index": "./docs/index.md",
"asset": "./docs/images",
"badge": false,
"installation": [
"./docs/getting-started.md",
"./docs/usage.md"
],
"tutorial": [
"./docs/models-definition.md",
"./docs/models-usage.md",
"./docs/querying.md",
"./docs/instances.md",
"./docs/associations.md",
"./docs/transactions.md",
"./docs/scopes.md",
"./docs/hooks.md",
"./docs/raw-queries.md",
"./docs/migrations.md",
"./docs/upgrade-to-v4.md"
],
"advanced": [
"./docs/legacy.md"
],
"faq": [
"./docs/whos-using.md",
"./docs/legal.md"
]
}
}
{
"name": "esdoc-inject-style-plugin",
"option": {
"enable": true,
"styles": [
"./docs/css/style.css",
"./docs/css/theme.css"
]
}
},
{
"name": "esdoc-standard-plugin",
"option": {
"lint": { "enable": true },
"coverage": { "enable": false },
"accessor": {
"access": ["public"],
"autoPrivate": true
},
"undocumentIdentifier": { "enable": false },
"unexportedIdentifier": { "enable": true },
"typeInference": { "enable": true },
"brand": {
"logo": "./docs/images/logo-small.png",
"title": "Sequelize",
"description": "Node.js ORM for PostgreSQL, MySQL, SQLite and MSSQL",
"repository": "https://github.com/sequelize/sequelize",
"site": "http://docs.sequelizejs.com/"
},
"manual": {
"index": "./docs/index.md",
"globalIndex": true,
"asset": "./docs/images",
"files": [
"./docs/getting-started.md",
"./docs/usage.md",
"./docs/models-definition.md",
"./docs/models-usage.md",
"./docs/querying.md",
"./docs/instances.md",
"./docs/associations.md",
"./docs/transactions.md",
"./docs/scopes.md",
"./docs/hooks.md",
"./docs/raw-queries.md",
"./docs/migrations.md",
"./docs/upgrade-to-v5.md",
"./docs/upgrade-to-v4.md",
"./docs/legacy.md",
"./docs/whos-using.md",
"./docs/legal.md"
]
}
}
}
]
}
\ No newline at end of file
docs/css/style.css
@import url(https://fonts.googleapis.com/css?family=Titillium+Web);
.algolia-autocomplete .algolia-docsearch-suggestion--category-header,
.algolia-autocomplete .algolia-docsearch-suggestion--title,
.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column,
#docs-search-input {
font-size: 16px !important;
line-height: normal;
}
.algolia-autocomplete .algolia-docsearch-suggestion--wrapper {
padding: 0 !important;
}
.docs-search-container {
float: right;
margin-right: 30px;
}
#docs-search-input {
border: none;
background: transparent;
padding: 10px;
}
#docs-search-input, .docs-search-container {
height: 40px;
width: 300px;
}
/* ESDoc search */
.search-box {
display: none;
}
div.logo img {
width: 200px;
height: 200px;
box-shadow: none !important;
}
div.sequelize {
......@@ -44,59 +12,11 @@ div.sequelize {
font-family: 'Titillium Web', sans-serif;
}
.content {
max-width: 1200px;
}
.navigation {
overflow-x: hidden;
}
.manual-root .content img {
box-shadow: none !important;
max-width: 300px;
}
.manual-toc a {
width: 240px;
white-space: pre-wrap;
}
blockquote {
background: #fafafa;
border-left: 10px solid #ddd;
margin: 1.5em 10px;
padding: 0.5em 10px;
}
blockquote p {
margin-bottom: 0;
}
h3#static-variable-DataTypes ~ div[data-ice="properties"] table.params tr td:nth-child(3) {
display: none;
}
h3#static-variable-QueryTypes ~ div[data-ice="properties"] table.params tr td:nth-child(2),
h3#static-variable-QueryTypes ~ div[data-ice="properties"] table.params tr td:nth-child(3),
h3#static-variable-QueryTypes ~ div[data-ice="properties"] table.params tr td:nth-child(4) {
display: none;
}
.manual-badge,
.manual-cards {
display: none !important;
}
a[href="source.html"],
a[href^="file/lib/"] {
display: none;
}
.manual-color:after {
content: '' !important;
}
.slack-logo {
height: 20px;
position: relative;
......@@ -114,6 +34,7 @@ a[href^="file/lib/"] {
text-align: center;
}
pre {
white-space: pre-wrap;
.manual-root .content img {
box-shadow: none !important;
max-width: 300px;
}
docs/css/theme.css
......@@ -14,66 +14,3 @@
.kind-variable, .manual-color-reference a, .manual-color-faq a {
color: #ffffff;
}
.manual-toc-root ul li {
margin-top: 0.5em;
margin-bottom: 0.5em;
font-weight: normal !important;
}
.manual-toc .indent-h1 {
margin: 0.5em 0 0 .5em;
}
/* Class Summay*/
.summary thead tr {
background-color: #074278;
}
.summary thead span a {
font-weight: 600;
}
/* Params Table */
table.params thead {
background: none;
color: inherit;
font-weight: 600;
}
table.params ul {
padding: 0;
}
table.params ul li {
list-style: none;
}
table.params td {
padding: 4px 8px;
}
table.params td:first-child {
border-left: none;
}
table.params td:last-child {
border-right: none;
}
table.params thead td {
border-top: none;
}
table.params tbody tr:last-child td {
border-bottom: none;
}
.informal {
display: block;
padding-left: 1.3em;
border-left: 5px solid #dfdfdf;
font-size: 1.1em;
font-family: 'Kalam', cursive;
margin: 22px 0;
}
docs/index.md
<div>
<div class="center logo">
![logo](manual/asset/logo-small.png)
![logo](/manual/asset/logo-small.png)
</div>
<div class="center sequelize">Sequelize</span>
</div>
......@@ -8,6 +8,7 @@
[![Travis build](https://img.shields.io/travis/sequelize/sequelize/master.svg?style=flat-square)](https://travis-ci.org/sequelize/sequelize)
[![npm](https://img.shields.io/npm/dm/sequelize.svg?style=flat-square)](https://npmjs.org/package/sequelize)
[![npm](https://img.shields.io/npm/v/sequelize.svg?style=flat-square)](https://github.com/sequelize/sequelize/releases)
[![Slack Status](http://sequelize-slack.herokuapp.com/badge.svg)](http://sequelize-slack.herokuapp.com/)
Sequelize is a promise-based ORM for Node.js v4 and up. It supports the dialects PostgreSQL, MySQL, SQLite and MSSQL and features solid transaction support, relations, read replication and more.
......
docs/plugins/esdoc-sequelize.js deleted 100644 → 0
'use strict';
const cheerio = require('cheerio');
const esdocConfig = require('../../.esdoc.json');
exports.onHandleHTML = function(ev) {
const $ = cheerio.load(ev.data.html);
const $title = $('head title');
if ($title.text().indexOf(esdocConfig.title) === -1) {
$title.text($title.text() + ' | ' + esdocConfig.title);
}
const $header = $('header');
$header.prepend('<a href="/"><img src="manual/asset/logo-small.png" class="header-logo" /></a>');
$('.repo-url-github').after('<a href="http://sequelize-slack.herokuapp.com/" class="slack-link"><img class="slack-logo" src="manual/asset/slack.svg"/>Join us on Slack</a>');
// remove unnecessary scripts
const scripts = ['script/search_index.js', 'script/search.js', 'script/inherited-summary.js', 'script/test-summary.js', 'script/inner-link.js'];
for (const script of scripts) {
$(`script[src="${script}"]`).remove();
}
// Algolia search
if (process.env.ALGOLIA_API_KEY) {
$('head').append('<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />');
$header.append('<div class="docs-search-container"><input type="search" id="docs-search-input" placeholder="Search..."></div>');
$('body').append(`
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
apiKey: '${process.env.ALGOLIA_API_KEY}',
indexName: 'sequelizejs',
inputSelector: '#docs-search-input',
debug: false // Set debug to true if you want to inspect the dropdown
});
document.getElementById('docs-search-input').focus();
</script>
`);
} else {
console.log('Set ALGOLIA_API_KEY environment variable to enable Algolia search field');
}
ev.data.html = $.html();
};
docs/scripts/script.js deleted 100644 → 0
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-96831523-1', 'auto');
ga('send', 'pageview');
docs/upgrade-to-v4.md
# Upgrade to V4
# Upgrade to v4
Sequelize v4 is the current release and it introduces some breaking changes. Majority of sequelize codebase has been refactored to use ES2015 features. The following guide lists some of the changes to upgrade from v3 to v4.
......
docs/upgrade-to-v5.md
# Upgrade to v5
# Upgrade to v5-beta
Sequelize v5 is the next major release after v4
......
docs/whos-using.md
# Who's using sequelize?
[![Walmart labs logo](asset/walmart-labs-logo.png)](http://www.walmartlabs.com/)
[![Walmart labs logo](/manual/asset/walmart-labs-logo.png)](http://www.walmartlabs.com/)
> ... we are avid users of sequelize (and have been for the past 18 months) (Feb 2017)
<hr />
[![Snaplytics logo](asset/logo-snaplytics-green.png)](https://snaplytics.io)
[![Snaplytics logo](/manual/asset/logo-snaplytics-green.png)](https://snaplytics.io)
> We've been using sequelize since we started in the beginning of 2015. We use it for our graphql servers (in connection with [graphql-sequelize](http://github.com/mickhansen/graphql-sequelize)), and for all our background workers.
<hr />
[![Connected Cars logo](asset/connected-cars.png)](https://connectedcars.io/)
[![Connected Cars logo](/manual/asset/connected-cars.png)](https://connectedcars.io/)
<hr />
[![Bitovi Logo](asset/bitovi-logo.png)](https://bitovi.com)
[![Bitovi Logo](/manual/asset/bitovi-logo.png)](https://bitovi.com)
> We have used Sequelize in enterprise projects for some of our Fortune 100 and Fortune 500 clients. It is used in deployments that are depended on by hundreds of millions of devices every year.
<hr />
[![ErmesHotels Logo](asset/ermeshotels-logo.png)](https://ermeshotels.com)
[![ErmesHotels Logo](/manual/asset/ermeshotels-logo.png)](https://www.ermeshotels.com)
> Using Sequelize in production for two different apps with 30k+ daily users by 2 years. I doubt there is something better at this moment in terms of productivity and features.
package.json
......@@ -17,6 +17,11 @@
"bugs": {
"url": "https://github.com/sequelize/sequelize/issues"
},
"main": "index.js",
"engines": {
"node": ">=6.0.0"
},
"license": "MIT",
"dependencies": {
"bluebird": "^3.5.0",
"cls-bluebird": "^2.1.0",
......@@ -47,8 +52,10 @@
"cross-env": "^5.2.0",
"docdash": "^1.0.0",
"env-cmd": "^8.0.0",
"esdoc": "^0.5.2",
"eslint": "^5.0.0",
"esdoc": "^1.1.0",
"esdoc-inject-style-plugin": "^1.0.0",
"esdoc-standard-plugin": "^1.0.0",
"eslint": "^5.6.0",
"eslint-plugin-jsdoc": "^3.7.1",
"eslint-plugin-mocha": "^5.0.0",
"hints": "^1.x",
......@@ -63,7 +70,7 @@
"pg-native": "^3.0.0",
"pg-types": "^1.x",
"rimraf": "^2.x",
"sinon": "^6.0.0",
"sinon": "^6.3.3",
"sinon-chai": "^3.2.0",
"sqlite3": "^4.0.2",
"tedious": "^2.x",
......@@ -79,7 +86,6 @@
"nodejs",
"object relational mapper"
],
"main": "index",
"options": {
"env_cmd": "./test/config/.docker.env"
},
......@@ -128,9 +134,5 @@
"sscce-postgres": "cross-env DIALECT=postgres npm run sscce",
"sscce-sqlite": "cross-env DIALECT=sqlite npm run sscce",
"commitmsg": "commitlint -E GIT_PARAMS"
},
"engines": {
"node": ">=6.0.0"
},
"license": "MIT"
}
}
test/integration/include.test.js
......@@ -379,7 +379,7 @@ describe(Support.getTestDialectTeaser('Include'), () => {
});
});
it('should support a simple nested hasMany <-> hasMany include', function() {
it('should support a simple nested hasMany to hasMany include', function() {
const User = this.sequelize.define('User', {}),
Product = this.sequelize.define('Product', {
title: DataTypes.STRING
......
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!