Skip to content

Commit

Permalink
Merge pull request #3 from IOMechs/fix/installing-package-doesnt-warn…
Browse files Browse the repository at this point in the history
…-about-dependencies

fix(core): add date-fns and @angular/cdk to peerDependencies
  • Loading branch information
AhsanAyaz committed Jan 4, 2020
2 parents 0bea158 + b73f7bd commit b743846
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 11 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ A simple, easily to use Year calendar for your Angular apps.

[https://iomechs.github.io/angular-year-calendar](https://iomechs.github.io/angular-year-calendar)

## Dependencies

The Angular Year Calendar library depends on [date-fns](https://www.npmjs.com/package/date-fns) and [@angular/cdk](https://www.npmjs.com/package/@angular/cdk). If you don't have them installed in your project, you'll have to install them urself.

## Usage

Install the package in your project's folder by using npm or yarn:
Expand Down
6 changes: 5 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ <h2 id="demo">Demo</h2>
<p><a href="https://iomechs.github.io/angular-year-calendar/demo">https://iomechs.github.io/angular-year-calendar/demo</a></p>
<h2 id="docs">Docs</h2>
<p><a href="https://iomechs.github.io/angular-year-calendar">https://iomechs.github.io/angular-year-calendar</a></p>
<h2 id="dependencies">Dependencies</h2>
<p>The Angular Year Calendar library depends on <a href="https://www.npmjs.com/package/date-fns">date-fns</a> and <a href="https://www.npmjs.com/package/@angular/cdk">@angular/cdk</a>. If you don&#39;t have them installed in your project, you&#39;ll have to install them urself.</p>
<h2 id="usage">Usage</h2>
<p>Install the package in your project&#39;s folder by using npm or yarn:</p>
<div><pre class="line-numbers"><code class="language-bash">npm install &#64;iomechs/angular-year-calendar --save
Expand All @@ -71,7 +73,9 @@ <h2 id="usage">Usage</h2>
(eventDayClicked)=&quot;eventDayClickHandler($event)&quot;
[ycConfig]=&quot;myCalendarConfig&quot;
[selectedDate]=&quot;currentDate&quot;&gt;
&lt;/yc-year-calendar&gt;</code></pre></div>
&lt;/yc-year-calendar&gt;</code></pre></div><h2 id="license">License</h2>
<p>MIT © <a href="https://github.com/IOmechs">IOMechs</a></p>




Expand Down
4 changes: 2 additions & 2 deletions docs/js/search/search_index.js

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,17 @@
"test": "ng test",
"test:lib": "ng test angular-year-calendar --watch false",
"lint": "ng lint",
"copy:readme": "cp projects/angular-year-calendar/README.md ./",
"copy:license": "cp projects/angular-year-calendar/LICENSE ./",
"copy:readme": "cp ./README.md projects/angular-year-calendar/",
"copy:license": "cp ./LICENSE projects/angular-year-calendar/",
"copy:demo:ci": "cp -R dist/demo ./docs/demo",
"pre-release": "npm run lint && npm run build:lib && npm run test:lib && npm run docs:build && npm run copy:readme",
"pre-release": "npm run lint && npm run copy:readme && npm run copy:license && npm run build:lib && npm run test:lib && npm run docs:build",
"publish:lib": "npm publish dist/angular-year-calendar --access public",
"release": "npm run pre-release && npm run publish:lib",
"e2e": "ng e2e",
"deploy": "ng deploy demo --base-href=/angular-year-calendar/"
},
"private": true,
"license": "MIT",
"private": false,
"dependencies": {
"@angular/animations": "~8.2.11",
"@angular/cdk": "^8.2.3",
Expand Down
4 changes: 4 additions & 0 deletions projects/angular-year-calendar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ A simple, easily to use Year calendar for your Angular apps.

[https://iomechs.github.io/angular-year-calendar](https://iomechs.github.io/angular-year-calendar)

## Dependencies

The Angular Year Calendar library depends on [date-fns](https://www.npmjs.com/package/date-fns) and [@angular/cdk](https://www.npmjs.com/package/@angular/cdk). If you don't have them installed in your project, you'll have to install them urself.

## Usage

Install the package in your project's folder by using npm or yarn:
Expand Down
9 changes: 7 additions & 2 deletions projects/angular-year-calendar/ng-package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,10 @@
"dest": "../../dist/angular-year-calendar",
"lib": {
"entryFile": "src/public-api.ts"
}
}
},
"whitelistedNonPeerDependencies": [
"tslib",
"date-fns",
"cdk"
]
}
6 changes: 4 additions & 2 deletions projects/angular-year-calendar/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
{
"name": "@iomechs/angular-year-calendar",
"version": "0.1.1",
"version": "0.1.5",
"peerDependencies": {
"@angular/common": "^8.2.11",
"@angular/core": "^8.2.11"
"@angular/core": "^8.2.11",
"date-fns": "^2.5.1",
"@angular/cdk": "^8.2.3"
}
}

0 comments on commit b743846

Please sign in to comment.