Merge pull request #39 from jonasmerlin/1.0

1.0

README.md

@@ -36,22 +36,22 @@ Propname | Type | Description
 ------------ | ------------- | -------------
 title | string | The title of the page.
 description | string | Text that gives a concise description of what your page is about.
-canonical | string | Prevent duplicate content issues by specifying the "canonical" or "preferred" url of a web page. If you don't define this, `Astro.request.canonicalURL.href` will be used as the default value.
+canonical | string | Prevent duplicate content issues by specifying the "canonical" or "preferred" url of a web page. If you don't define this, `Astro.request.url.href` will be used as the default value.
 noindex | boolean | Set this to true if you don't want search engines to index your page. Since this is an SEO component, this gets set to `false` by default. This way, indexing is strictly opt-out.
 nofollow | boolean | Set this to true if you don't want search engines to follow links on your page. Since this is an SEO component, this gets set to `false` by default. This way, following links is strictly opt-out.
 openGraph.basic.title | string | Set the title Open Graph should use. __In most situations, this should be _different_ from the value of the `title` prop.__ See [this tweet](https://twitter.com/jon_neal/status/1428721238071988237) to gain an understanding of the difference between the two. If you define this, you must define two other OG basic properties as well: `type` and `image`. ([Learn more.](https://ogp.me/#metadata))
 openGraph.basic.type | string | Set the [type](https://ogp.me/#types) Open Graph should use. If you define this, you must define two other OG basic properties as well: `title` and `image`. ([Learn more.](https://ogp.me/#metadata))
 openGraph.basic.image | string | URL of the image that should be used in social media previews. If you define this, you must define two other OG basic properties as well: `title` and `type`. ([Learn more.](https://ogp.me/#metadata))
-openGraph.basic.url | string | The canonical URL of your object that will be used as its permanent ID in the graph. Most likely either the url of the page or its canonical url (see above). If you define this, you must define the other 3 OG basic properties as well: `title`, `type` and `image`. ([Learn more.](https://ogp.me/#metadata)). If you define the other 3 OG basic properties but don't define this, `Astro.request.canonicalURL.href` will be used as the default value.
+openGraph.basic.url | string | The canonical URL of your object that will be used as its permanent ID in the graph. Most likely either the url of the page or its canonical url (see above). If you define this, you must define the other 3 OG basic properties as well: `title`, `type` and `image`. ([Learn more.](https://ogp.me/#metadata)). If you define the other 3 OG basic properties but don't define this, `Astro.request.url.href` will be used as the default value.
 openGraph.optional.audio | string | A URL to an audio file to accompany this object.
-openGraph.optional.description | string | A one to two sentence description of your object. 
+openGraph.optional.description | string | A one to two sentence description of your object.
 openGraph.optional.determiner | string | The word that appears before this object's title in a sentence. An enum of (a, an, the, "", auto). If auto is chosen, the consumer of your data should chose between "a" or "an". Default is "" (blank).
 openGraph.optional.locale | string | The locale these tags are marked up in. Of the format language_TERRITORY. Default is en_US.
 openGraph.optional.localeAlternate | Array<string> | An array of other locales this page is available in.
 openGraph.optional.siteName | string | If your object is part of a larger web site, the name which should be displayed for the overall site. e.g., "IMDb".
 openGraph.optional.video | string | A URL to a video file that complements this object.
 openGraph.image.url | string | For now, setting this is ignored. This is done because `og:image:url` is supposed to be identical to `og:image`. If you have a use case where it makes sense for these to be different, please feel free to contact me, and tell me about it and I will consider adding it. Until then, in the interest of enforcing best practices, the value of this property will be ignored and `og:image:url` set to the value of `openGraph.basic.image`.
-openGraph.image.secureUrl | string | Sets `og:image:secure_url`: An alternate url to use if the webpage requires HTTPS. 
+openGraph.image.secureUrl | string | Sets `og:image:secure_url`: An alternate url to use if the webpage requires HTTPS.
 openGraph.image.type | string | Sets `og:image:type`. A MIME type for the image. e.g. "image/jpeg"
 openGraph.image.width | number | Sets `og:image:width`. The number of pixels wide.
 openGraph.image.height | number | Sets `og:image:height`. The number of pixels high.
@@ -129,15 +129,15 @@ There's certainly no magic to what Astro SEO does. Basically, it bundles the
 creation of regular SEO-relevant HTML tags inside one component that you can
 then use inside your page's `<head>` tag.
 
-The translation between props and tags is pretty direct and almost 1:1. After 
+The translation between props and tags is pretty direct and almost 1:1. After
 building, there probably won't be anything you wouldn't have written yourself.
-The idea is to surface the options that exist in a central place and adhere to 
-best practices where it's theoretically possible not to. __If you want to see 
-how the sausage gets made, there's only one place you will have to check__: 
+The idea is to surface the options that exist in a central place and adhere to
+best practices where it's theoretically possible not to. __If you want to see
+how the sausage gets made, there's only one place you will have to check__:
 `/src/SEO.astro`
 
 If you want, you can view Astro SEO as a checklist, so you don't forget a tag.
-Or maybe also as an educational tool, to see which options exist in the first 
+Or maybe also as an educational tool, to see which options exist in the first
 place.
 
 ## Acknowledgements

cypress.config.js

@@ -0,0 +1,11 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  e2e: {
+    // We've imported your old cypress plugins here.
+    // You may want to clean this up later by importing these.
+    setupNodeEvents(on, config) {
+      return require('./cypress/plugins/index.js')(on, config)
+    },
+  },
+})

cypress/integration/seo.spec.js → cypress/e2e/seo.cy.js

@@ -106,11 +106,11 @@ describe("Basic Tags Without URL", () => {
     );
   });
 
-  it("The Open Graph Url property defaults to Astro.request.canonicalURL.href", () => {
+  it("The Open Graph Url property defaults to Astro.request.url.href", () => {
     cy.get('head meta[property="og:url"]').should(
       "have.attr",
       "content",
-      "http://localhost:3000/ogBasicTagsWithoutUrl/"
+      "http://localhost:3000/ogBasicTagsWithoutUrl"
     );
   })
 });