feat/season-plugin-option #11

PaulieScanlon · 2021-11-15T13:38:21Z

add season start and end

The only slight snag with this is:

When a user sets the dates via the plugin options it must be a valid date object which includes the year. Naturally, next year this wouldn't start the snow unless the user changes the year in the options

    {
      resolve: "@raae/gatsby-plugin-let-it-snow",
      options: {
        season: {
          start: new Date("December 1, 2021"), // date including year
          end: new Date("January 1, 2022"), // date including year
        },
      },
    },

PaulieScanlon · 2021-11-15T13:58:17Z

plugin/gatsby-browser.js

@@ -40,5 +41,14 @@ export const onInitialClientRender = (_, options) => {
    }
  };

-  frame();
+  if (season) {


We could do if(season && new Date() ...) not sure if you're a fan of nested if statements or not?

No real preference.

raae · 2021-11-15T20:41:47Z

I think you can do custom validation, ie. letting folks write:

{
  resolve: "@raae/gatsby-plugin-let-it-snow",
  options: {
    season: {
      start: 12-01
      end: 01-01
    },
  },
},

And then custom verify that the string prefixed with the year is date...

I also think these dates should be the defaults if no season is set (making it a breaking change 🤯).

PaulieScanlon · 2021-11-15T20:45:54Z

Dates are hard but to me 12-01 is the 12th of January so maybe the long hand way will work better so folks have to write it out saving confusion.

Also agree it should have a default.

Breaking change is ok. It can be the first stable version 1.0.0

... but we should probably add a CHANGELOG.md so it's clear, as well as of course, updating the README.md

raae · 2021-11-15T20:50:22Z

What about your proposal + a flag for repeat every year? That is true by default?

raae · 2021-11-15T20:54:57Z

See #12 for changelog

PaulieScanlon · 2021-11-15T20:57:47Z

I'll have to look into it but you need the year in the date sting for it to be valid, and then to be able to run getTime on the date object which was the easiest way I could think of to handle the condition.

I'd be inclined to leave it and if folks want it next year they can update the date string.

PaulieScanlon · 2021-11-15T21:02:33Z

I think as well using the date string folks could include a time

E.g

end: new Date("December 31, 2021 11:59:00")

And the getTime condition would still work

raae · 2021-11-16T14:30:39Z

plugin/gatsby-browser.js

-  frame();
+  if (season) {
+    if (
+      new Date(now).getTime() >= new Date(season.start).getTime() &&


question: Aren't season.start already a date?

They are but they get passed as string so you can't run getTime() on the unless the new Date constructor is used

raae · 2021-11-16T14:31:25Z

I really want it to start again next year, might look into it a little.

PaulieScanlon · 2021-11-16T15:38:45Z

There's other ways to do this by changing the config to use a start and end month / day

Maybe something like this?

  plugins: [
    {
      resolve: "@raae/gatsby-plugin-let-it-snow",
      options: {
        season: {
          start: {
            day: 1,
            month: 12,
          },
          end: {
            day: 31,
            month: 12,
          },
        },
      },
    },
  ],

Then i guess those values could be used to construct a new Date and the year bit gets added by the plugin. This would then repeat each year and because a date is still constructed, the getTime() method to evaluate if it's within range would still work.

If you like the above API i can make the change, it's no trouble at all Queen!

raae · 2021-11-17T06:59:22Z

Let's ask Twitter 🎉

raae · 2021-11-21T08:44:56Z

Let's do it as you proposed and I will try to sneak in a repeat flag at some point.

raae

I can add the defaults, if you add me to your fork.

raae · 2021-11-21T08:46:19Z

plugin/gatsby-node.js

@@ -4,5 +4,11 @@ exports.pluginOptionsSchema = ({ Joi }) => {
    colors: Joi.array()
      .items(Joi.string().default("#ffffff"))
      .description("Array of hex color values"),
+    season: Joi.object()
+      .keys({
+        start: Joi.date(),


nitpick: Add default dates.

PaulieScanlon

Lovely stuff!

# [0.4.0](v0.3.0...v0.4.0) (2021-12-03) ### Features * season-plugin-option, solves [#2](#2) ([#11](#11)) ([9319fa0](9319fa0))

raae-bot · 2021-12-03T14:33:46Z

🎉 This PR is included in version 0.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

## [0.4.1](v0.4.0...v0.4.1) (2021-12-03) ### Bug Fixes * duration broken by [#11](#11) ([616a01f](616a01f))

pauliescanlon added 2 commits November 15, 2021 13:34

feat: add season start and end

969a0ff

feat: add pluginOptionsSchema for season

18b2f17

PaulieScanlon mentioned this pull request Nov 15, 2021

Add season plugin option #2

Closed

PaulieScanlon commented Nov 15, 2021

View reviewed changes

pauliescanlon added 4 commits November 15, 2021 21:13

chore: merge with upstream/main

f8890ac

chore: update README with time included in date string

89f7368

chore: blast - add seconds to end time string

b0b29d1

chore: test max time in seconds

1ead1b3

raae reviewed Nov 16, 2021

View reviewed changes

raae requested changes Nov 21, 2021

View reviewed changes

raae added 7 commits December 3, 2021 13:52

chore: add date-fns package

510c4ac

docs: update readme

96bc4af

fix: better defaults

ed088a7

feat: only do snow when in season

c2e44c8

chore: full config of plugin in demo

9954324

chore: only rely on schema defaults

edccf3f

fix: catch all possible season errors

ff0488f

PaulieScanlon commented Dec 3, 2021

View reviewed changes

Merge branch 'main' into feat/season-plugin-option

6ae79e5

raae closed this Dec 3, 2021

raae reopened this Dec 3, 2021

raae merged commit 9319fa0 into queen-raae:main Dec 3, 2021

raae-bot pushed a commit that referenced this pull request Dec 3, 2021

chore(release): 0.4.0 [skip ci]

3b1f222

# [0.4.0](v0.3.0...v0.4.0) (2021-12-03) ### Features * season-plugin-option, solves [#2](#2) ([#11](#11)) ([9319fa0](9319fa0))

raae-bot added the released label Dec 3, 2021

raae linked an issue Dec 3, 2021 that may be closed by this pull request

Add season plugin option #2

Closed

raae added a commit that referenced this pull request Dec 3, 2021

fix: duration broken by #11

616a01f

raae-bot pushed a commit that referenced this pull request Dec 3, 2021

chore(release): 0.4.1 [skip ci]

a5a9b1c

## [0.4.1](v0.4.0...v0.4.1) (2021-12-03) ### Bug Fixes * duration broken by [#11](#11) ([616a01f](616a01f))

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat/season-plugin-option #11

feat/season-plugin-option #11

PaulieScanlon commented Nov 15, 2021 •

edited

Loading

PaulieScanlon Nov 15, 2021

raae Nov 21, 2021

raae commented Nov 15, 2021 •

edited

Loading

PaulieScanlon commented Nov 15, 2021

raae commented Nov 15, 2021 •

edited

Loading

raae commented Nov 15, 2021

PaulieScanlon commented Nov 15, 2021 •

edited

Loading

PaulieScanlon commented Nov 15, 2021 •

edited

Loading

raae Nov 16, 2021

PaulieScanlon Nov 16, 2021

raae Nov 16, 2021

raae commented Nov 16, 2021

PaulieScanlon commented Nov 16, 2021

raae commented Nov 17, 2021

raae commented Nov 21, 2021

raae left a comment

raae Nov 21, 2021 •

edited

Loading

PaulieScanlon left a comment

raae-bot commented Dec 3, 2021

feat/season-plugin-option #11

feat/season-plugin-option #11

Conversation

PaulieScanlon commented Nov 15, 2021 • edited Loading

PaulieScanlon Nov 15, 2021

Choose a reason for hiding this comment

raae Nov 21, 2021

Choose a reason for hiding this comment

raae commented Nov 15, 2021 • edited Loading

PaulieScanlon commented Nov 15, 2021

raae commented Nov 15, 2021 • edited Loading

raae commented Nov 15, 2021

PaulieScanlon commented Nov 15, 2021 • edited Loading

PaulieScanlon commented Nov 15, 2021 • edited Loading

raae Nov 16, 2021

Choose a reason for hiding this comment

PaulieScanlon Nov 16, 2021

Choose a reason for hiding this comment

raae Nov 16, 2021

Choose a reason for hiding this comment

raae commented Nov 16, 2021

PaulieScanlon commented Nov 16, 2021

raae commented Nov 17, 2021

raae commented Nov 21, 2021

raae left a comment

Choose a reason for hiding this comment

raae Nov 21, 2021 • edited Loading

Choose a reason for hiding this comment

PaulieScanlon left a comment

Choose a reason for hiding this comment

raae-bot commented Dec 3, 2021

PaulieScanlon commented Nov 15, 2021 •

edited

Loading

raae commented Nov 15, 2021 •

edited

Loading

raae commented Nov 15, 2021 •

edited

Loading

PaulieScanlon commented Nov 15, 2021 •

edited

Loading

PaulieScanlon commented Nov 15, 2021 •

edited

Loading

raae Nov 21, 2021 •

edited

Loading