@poppinss/manager - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

build/index.d.ts

@@ -1,3 +0,2 @@
-/// <reference path="src/contracts.d.ts" />
 export { Manager } from './src/Manager';
-export { ManagerContract } from '@poppinss/manager/contracts';
+export { ManagerContract } from './src/contracts';

build/src/contracts.d.ts

@@ -1,6 +0,4 @@
-declare module '@poppinss/manager/contracts' {
-    interface ManagerContract<DriverContract extends any, DriversList extends string = any> {
-        driver(name?: DriversList): DriverContract;
-        extend(name: string, callback: (container: any) => DriverContract): void;
-    }
+export interface ManagerContract<DriverContract extends any, DriversList extends string = any> {
+    driver(name?: DriversList): DriverContract;
+    extend(name: string, callback: (container: any) => DriverContract): void;
 }

build/src/Manager.d.ts

@@ -1,3 +0,2 @@
-/// <reference path="contracts.d.ts" />
-import { ManagerContract } from '@poppinss/manager/contracts';
+import { ManagerContract } from './contracts';
 export declare abstract class Manager<DriverContract extends any, DriversList extends string = any> implements ManagerContract<DriverContract, DriversList> {
@@ -4,0 +3,0 @@ protected $container: any;

package.json

 {
   "name": "@poppinss/manager",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "The builder (Manager) pattern implementation",
@@ -12,3 +12,3 @@ "scripts": {
     "compile": "npm run lint && npm run clean && tsc",
-    "build": "npm run compile && typedoc --excludePrivate && git add docs",
+    "build": "npm run compile && typedoc --theme markdown --excludePrivate --mdHideSources && git add docs",
     "commit": "git-cz",
@@ -26,6 +26,6 @@ "release": "np",
     "@adonisjs/mrm-preset": "^2.0.3",
-    "@types/node": "^12.0.2",
+    "@types/node": "^12.0.3",
     "commitizen": "^3.1.1",
     "cz-conventional-changelog": "^2.1.0",
-    "del-cli": "^1.1.0",
+    "del-cli": "^2.0.0",
     "doctoc": "^1.4.0",
@@ -36,3 +36,3 @@ "husky": "^2.3.0",
     "np": "^5.0.2",
-    "ts-node": "^8.1.0",
+    "ts-node": "^8.2.0",
     "tslint": "^5.16.0",
@@ -42,3 +42,4 @@ "tslint-eslint-rules": "^5.4.0",
     "typedoc-plugin-external-module-name": "^2.1.0",
-    "typescript": "^3.4.5"
+    "typedoc-plugin-markdown": "^1.2.1",
+    "typescript": "^3.5.1"
   },
@@ -45,0 +46,0 @@ "nyc": {

README.md

@@ -8,3 +8,3 @@ <div align="center">
 
-[![circleci-image]][circleci-url] [![npm-image]][npm-url] ![](https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript)
+[![circleci-image]][circleci-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]
 
@@ -16,13 +16,11 @@ <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 - [Usage](#usage)
-- [Usage](#usage-1)
 - [How it works?](#how-it-works)
     - [Drivers](#drivers)
     - [Session main class](#session-main-class)
-    - [Usage](#usage-2)
+    - [Usage](#usage-1)
 - [Using Manager class](#using-manager-class)
 - [Adding drivers from outside](#adding-drivers-from-outside)
 - [Autocomplete drivers list](#autocomplete-drivers-list)
-- [Change log](#change-log)
-- [Contributing](#contributing)
-- [Authors & License](#authors--license)
+- [API Docs](#api-docs)
+- [Maintainers](#maintainers)
 
@@ -32,3 +30,2 @@ <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 ## Usage
-## Usage
 Install the package from npm as follows:
@@ -90,3 +87,3 @@
 
-The above example is very simple and may feel fine at first glance. However, you will may following challenges.
+The above example is very simple and may feel fine at first glance. However, you may face following challenges.
 
@@ -152,19 +149,10 @@ 1. It is not easy to switch drivers, since you have to manually re-create the driver and then create instance of the session class.
 
-## Change log
+## API Docs
+Following are the autogenerated files via Typedoc
 
-The change log can be found in the [CHANGELOG.md](CHANGELOG.md) file.
+* [API](docs/README.md)
 
-## Contributing
+## Maintainers
+[Harminder virk](https://github.com/thetutlage)
 
-Everyone is welcome to contribute. Please go through the following guides, before getting started.
-
-1. [Contributing](https://adonisjs.com/contributing)
-2. [Code of conduct](https://adonisjs.com/code-of-conduct)
-
-
-## Authors & License
-[Harminder virk](https://github.com/Harminder virk) and [contributors](https://github.com/poppinss/manager/graphs/contributors).
-
-MIT License, see the included [MIT](LICENSE.md) file.
-
 [circleci-image]: https://img.shields.io/circleci/project/github/poppinss/manager/master.svg?style=for-the-badge&logo=circleci
@@ -175,1 +163,6 @@ [circleci-url]: https://circleci.com/gh/poppinss/manager "circleci"
 [npm-url]: https://npmjs.org/package/@poppinss/manager "npm"
+
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+
+[license-url]: LICENSE.md
+[license-image]: https://img.shields.io/aur/license/pac.svg?style=for-the-badge

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

10458

decreased by-2.69%

Dev dependency count

17

increased by6.25%

Lines of code

76

decreased by-2.56%

Number of lines in readme file

163

decreased by-4.12%

No dependency changes