Skip to content
This repository has been archived by the owner on Sep 16, 2022. It is now read-only.

Commit

Permalink
see changelog for v1.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jdhitsolutions committed Nov 28, 2018
1 parent 0243b48 commit 48866eb
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 38 deletions.
15 changes: 11 additions & 4 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
### PSVersion Table
# Issue

## PSVersion Table

<!-- copy the contents of $PSVersionTable -->

### What is the syntax or expression you are using?
## What is the syntax or expression you are using?

<!-- copy command you are trying to run -->

### What happens?
## What happens?

<!-- copy the results especially any error messages -->

### What do you think should happen?
## What do you think should happen?

<!-- What are your expectations or assumptions -->
3 changes: 1 addition & 2 deletions MyTasks.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@
# Module manifest for module 'MyTasks'
#


@{

# Script module or binary module file associated with this manifest.
RootModule = 'MyTasks.psm1'

# Version number of this module.
ModuleVersion = '1.7.0'
ModuleVersion = '1.8.0'

# ID used to uniquely identify this module
GUID = '6a5db6e0-9669-4178-a176-54b4931aa4e2'
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This module requires at least PowerShell version 5.0 since is uses a class defin

## XML Data

All of the task information is stored in an XML file. The commands in this module will read in, update, and remove items as needed using PowerShell commands such as `Select-XML`. By default these files are stored in your Documents folder (on Windows systems) or in Home (on Linux). You can change the default location by using the `Set-myTaskPath` command. This is helpful if you are sharing task information between laptops via a service like Dropbox.
All of the task information is stored in an XML file. The commands in this module will read in, update, and remove items as needed using PowerShell commands such as `Select-XML`. By default these files are stored in your Documents folder (on Windows systems) or in Home (on Linux). You can change the default location by using the [Set-myTaskPath](./docs/Set-MyTaskPath.md) command. This is helpful if you are sharing task information between laptops via a service like Dropbox.

```powershell
Set-MyTaskPath Drop:\mytasks\
Expand All @@ -24,11 +24,11 @@ If you use this feature, you'll need to make sure you run this command before do

## Categories

The Task object includes a Category property. The module will define a default set of categories, but users can create their own by using the MyTaskCategory commands:
The Task object includes a Category property. The module will define a default set of categories ("Work","Personal","Customer","Other"), but users can create their own by using the MyTaskCategory commands:

+ Add-MyTaskCategory
+ Get-MyTaskCategory
+ Remove-MyTaskCategory
+ [Add-MyTaskCategory](./docs/Add-MyTaskCategory.md)
+ [Get-MyTaskCategory](./docs/Get-MyTaskCategory.md)
+ [Remove-MyTaskCategory](./docs/Remove-MyTaskCategory.md)

## Basic Usage

Expand All @@ -50,13 +50,13 @@ You can use `Set-MyTask` to modify a task.
Get-MyTask Pluralsight | Set-Mytask -DueDate 3/1/2018
```

Because the task has a Progress property, you can use `Set-MyTask` to update that as well.
Because the task has a Progress property, you can use [Set-MyTask](./docs/Set-MyTask.md) to update that as well.

```powershell
Set-Mytask "book review" -Progress 60
```

To view tasks you can use `Get-MyTask`. Normally, you will use `Get-MyTask` to display tasks, all, some or a single item:
To view tasks you can use `Get-MyTask`. Normally, you will use [Get-MyTask](./docs/Get-MyTask.md) to display tasks, all, some or a single item:

```powershell
PS S:\> get-mytask -name MemoryTools
Expand All @@ -66,9 +66,9 @@ ID Name Description DueDate OverDue Category Progress
8 MemoryTools update module 7/22/2018 False Projects 10
```

The default behavior is to display incomplete tasks due in the next 30 days. Look at the help for [Get-MyTask](.\docs\Get-MyTask.md) for more information.
The default behavior is to display incomplete tasks due in the next 30 days. Look at the help for `Get-MyTask` for more information.

There is also a command called `Show-MyTask` which is really nothing more than a wrapper to `Get-MyTask`. The "Show" command will write output directly to the host. Incomplete tasks that are overdue will be displayed in red text. Tasks that will be due in 24 hours will be displayed in yellow. If you select all tasks then completed items will be displayed in green. This command may not work in the PowerShell ISE.
There is also a command called [Show-MyTask](./docs/Show-MyTask.md) which is really nothing more than a wrapper to `Get-MyTask`. The "Show" command will write output directly to the host. Incomplete tasks that are overdue will be displayed in red text. Tasks that will be due in 24 hours will be displayed in yellow. If you select all tasks then completed items will be displayed in green. This command may not work in the PowerShell ISE.

![show my tasks](./images/show-mytask-1.png)

Expand All @@ -78,7 +78,7 @@ When a task is finished you can mark it as complete.
Complete-MyTask -name "order coffee"
```

The task will remain but be marked as 100% complete. You can still see the task when using the -All parameter with `Get-MyTask` or `Show-MyTask`. At some point you might want to remove completed tasks from the master XML file. You can use `Remove-MyTask` to permanently delete them. Or use the `Archive-MyTask` command to move them to an archive xml file.
The task will remain but be marked as 100% complete. You can still see the task when using the -All parameter with `Get-MyTask` or `Show-MyTask`. At some point you might want to remove completed tasks from the master XML file. You can use [Remove-MyTask](./docs/Remove-MyTask.md) to permanently delete them. Or use the `Archive-MyTask` command to move them to an archive xml file.

## Format Views

Expand All @@ -94,11 +94,11 @@ Over time your task file might get quite large. Even though the default behavior
Get-Mytask -Completed | Archive-MyTask
```

There is an option to archive tasks when you run `Complete-MyTask`. There are no commands in this module for working with the archived XML file at this time. Or you can completely delete a task with `Remove-MyTask`.
There is an option to archive tasks when you run [Complete-MyTask](./docs/Complete-MyTask.md). There are no commands in this module for working with the archived XML file at this time. Or you can completely delete a task with `Remove-MyTask`.

## Email Reminders

If you are running this module on a Windows platform that includes the PSScheduledJob module, you can create a scheduled PowerShell job that will send you a daily email with tasks that are due in 3 days or less. The default is a plain text message but you can also send it as HTML. Use the `Enable-EmailReminder` command to set up the job.
If you are running this module on a Windows platform that includes the PSScheduledJob module, you can create a scheduled PowerShell job that will send you a daily email with tasks that are due in 3 days or less. The default is a plain text message but you can also send it as HTML. Use the [Enable-EmailReminder](./docs/Enable-EmailReminder.md) command to set up the job.

You should read full help and examples for all commands as well as the [about_MyTasks](./docs/about_MyTasks.md) help file.

Expand All @@ -122,4 +122,4 @@ You should read full help and examples for all commands as well as the [about_My

Please post any issues, questions or feature requests in the [Issues](https://github.com/jdhitsolutions/MyTasks/issues) section.

*last updated 22 October 2018*
*last updated 28 November 2018*
21 changes: 13 additions & 8 deletions Tests/MyTasks.tests.ps1
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@

if (get-module MyTasks) {
Remove-Module MyTasks
}

import-module $PSScriptRoot\..\Mytasks.psd1 -Force

InModuleScope MyTasks {
Expand Down Expand Up @@ -86,17 +90,18 @@ InModuleScope MyTasks {

Set-MyTaskPath TestDrive:

<# #need absolute path for XML files
new-Item -Name Documents -ItemType Directory -path TestDrive:
$home = $TestDrive
$mytaskhome = Join-Path $home -childpath Documents
$mytaskPath = Join-Path $home\Documents -child "myTasks.xml"
$myTaskArchivePath = Join-Path -Path $home\Documents -ChildPath "myTasksArchive.xml"
$myTaskCategory = Join-Path -path $home\Documents -childpath "myTaskCategory.txt" #>
<#
need absolute path for XML files
new-Item -Name Documents -ItemType Directory -path TestDrive:
$home = $TestDrive
$mytaskhome = Join-Path $home -childpath Documents
$mytaskPath = Join-Path $home\Documents -child "myTasks.xml"
$myTaskArchivePath = Join-Path -Path $home\Documents -ChildPath "myTasksArchive.xml"
$myTaskCategory = Join-Path -path $home\Documents -childpath "myTaskCategory.txt"
#>

Add-MyTaskCategory -Category Work, Personal, Other, Training, Testing


It "Should create a new task" {
$a = New-MyTask -Name Test1 -DueDate $Due -Category Testing -Passthru
$a.id | Should be 1
Expand Down
28 changes: 17 additions & 11 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log for MyTasks

## v1.8.0

+ Fixed Task Category bug (Issue #26) Thank you @shaneis
+ revised Pester test for category fix
+ Updated `README.md`

## v1.7.0

+ file cleanup for PowerShell Gallery
Expand All @@ -22,7 +28,7 @@

## v1.5.1

+ fixed bug with myTaskCategory (Issue #27)
+ fixed bug with MyTaskCategory (Issue #27)

## v1.5.0

Expand All @@ -48,7 +54,7 @@
+ Added CompletedDate parameter to Complete-MyTask (Issue #13)
+ Added option to complete a task by ID (Issue #11)
+ Changed default for `Get-MyTask` and `Show-MyTask` to display tasks due in next 30 days. (Issue #12)
+ fixed bug in `Show-Mytask` where completed tasks were displaying in red
+ fixed bug in `Show-MyTask` where completed tasks were displaying in red
+ Made parameters for `New-MyTask` more positional (Issue #14)
+ Updated help documentation

Expand Down Expand Up @@ -80,7 +86,7 @@
+ when none have been defined yet.
+ Modified `Show-MyTask` to work under the Windows 10
+ PowerShell ISE (Issue #2)
+ Modified `Remove-Mytask` to accept MyTask as an input object (Issue #3)
+ Modified `Remove-MyTask` to accept MyTask as an input object (Issue #3)
+ Help files are NOT updated yet to reflect these changes.
+ Updated `README.md`

Expand Down Expand Up @@ -109,8 +115,8 @@

## v0.0.15

+ fixed a regular expression bug in `Show-Mytask` that wasn't properly capturing completed tasks.
+ Modified `Show-Mytask` to display completed tasks in green.
+ fixed a regular expression bug in `Show-MyTask` that wasn't properly capturing completed tasks.
+ Modified `Show-MyTask` to display completed tasks in green.
+ Added command `Save-MyTasks` move completed tasks to an archive file.
+ Modified `Complete-MyTask` with an option to archive.

Expand All @@ -128,8 +134,8 @@
## v0.0.12

+ Added `Backup-MyTask`
+ modified format.ps1xml file to display DueDate without time when using tables. Format-List will show full DueDate value.
+ Added parameter to New-MyTask to allow specifying a number of days instead of an actual date.
+ modified `mytasks.format.ps1xml` file to display DueDate without time when using tables. Format-List will show full DueDate value.
+ Added parameter to `New-MyTask` to allow specifying a number of days instead of an actual date.

## v0.0.11

Expand All @@ -154,15 +160,15 @@

## v0.0.8

+ updated format.ps1xml file with new views
+ updated format.ps1xml to format DueDate
+ updated `MyTasks.format.ps1xml` file with new views
+ updated `MyTasks.format.ps1xml` to format DueDate
+ added verbose output to commands
+ Modified `Get-MyTask` to support filtering by Category
+ Modified `Show-MyTask` to display in yellow if due date is 24 hours or less

## v0.0.7

+ added format.ps1xml
+ added `MyTasks.format.ps1xml`
+ fixed a bug in `Set-MyTask` when there was an empty value
+ updated module files

Expand All @@ -175,7 +181,7 @@
## v0.0.5

+ Added `Set-MyTask` function
+ Modified `Get-Mytask` to take name as a positional parameter
+ Modified `Get-MyTask` to take name as a positional parameter
+ added command aliases
+ Updated module files

Expand Down

0 comments on commit 48866eb

Please sign in to comment.