Merge pull request #91 from WebDevStudios/fix/cleanup

Fix/cleanup

Author: Greg Rickaby

.eslintrc.js

@@ -37,6 +37,7 @@ module.exports = {
     'jsdoc/require-param': [
       'warn',
       {
+        checkRestProperty: true,
         unnamedRootBase: ['props']
       }
     ],

api/apolloConfig.js

@@ -10,9 +10,9 @@ export const APOLLO_STATE_PROP_NAME = '__APOLLO_STATE__'
  * Init Apollo and merge with initial state.
  *
  * @author WebDevStudios
- * @param  {Object} apolloClient Apollo client instance.
- * @param  {mixed}  initialState The initial state of things.
- * @return {Object}              Apollo client instance.
+ * @param {object} apolloClient Apollo client instance.
+ * @param {*}      initialState The initial state of things.
+ * @return {object}             Apollo client instance.
  */
 export function initializeApollo(apolloClient, initialState = null) {
   // If a page has Next.js data fetching methods that
@@ -43,9 +43,9 @@ export function initializeApollo(apolloClient, initialState = null) {
  * Pass down Apollo state to page props.
  *
  * @author WebDevStudios
- * @param  {Object} client    Apollo  Client props.
- * @param  {Object} pageProps Props from getStaticProps().
- * @return {Object}           Updated page props.
+ * @param {object} client    Apollo  Client props.
+ * @param {object} pageProps Props from getStaticProps().
+ * @return {object}          Updated page props.
  */
 export function addApolloState(client, pageProps) {
   if (pageProps?.props) {
@@ -59,8 +59,8 @@ export function addApolloState(client, pageProps) {
  * Only update when the cache value has changed.
  *
  * @author WebDevStudios
- * @param  {Object} pageProps Props from getStaticProps().
- * @return {Object}           WP Apollo client instance.
+ * @param {object} pageProps Props from getStaticProps().
+ * @return {object}          WP Apollo client instance.
  */
 export function useApollo(pageProps) {
   const state = pageProps[APOLLO_STATE_PROP_NAME]

api/frontend/connector.js

@@ -15,7 +15,7 @@ const restLink = new RestLink({
  * @see https://www.apollographql.com/docs/react/api/core/ApolloClient/
  *
  * @author WebDevStudios
- * @return {Object} Apollo client instance.
+ * @return {object} Apollo client instance.
  */
 export function createFeApolloClient() {
   return new ApolloClient({
@@ -29,8 +29,8 @@ export function createFeApolloClient() {
  * Init Apollo for Frontend API and merge with initial state.
  *
  * @author WebDevStudios
- * @param  {mixed} initialState Initial Apollo state.
- * @return {Object}             Frontend Apollo client instance.
+ * @param {*} initialState Initial Apollo state.
+ * @return {object}        Frontend Apollo client instance.
  */
 export function initializeFeApollo(initialState = null) {
   // Only run one instance of the Apollo client.

api/frontend/wp/archive/getArchivePosts.js

@@ -5,11 +5,11 @@ import {initializeFeApollo} from '../../connector'
  * Retrieve next page of posts for post type archive.
  *
  * @author WebDevStudios
- * @param  {string} postType WP post type.
- * @param  {string} orderBy  Order by: field.
- * @param  {string} order    Order by: direction.
- * @param  {string} cursor   Start cursor for pagination.
- * @return {Object}          Archive post and pagination data or error object.
+ * @param {string} postType WP post type.
+ * @param {string} cursor   Start cursor for pagination.
+ * @param {string} orderBy  Order by: field.
+ * @param {string} order    Order by: direction.
+ * @return {object}         Archive post and pagination data or error object.
  */
 export default async function getArchivePosts(
   postType,

api/wordpress/_global/getPostTypeArchive.js

@@ -12,13 +12,13 @@ import queryTestimonialsArchive from '../testimonials/queryTestimonialsArchive'
  * Retrieve post archive.
  *
  * @author WebDevStudios
- * @param  {string} postType WP post type.
- * @param  {string} orderBy  Order by: field.
- * @param  {string} order    Order by: direction.
- * @param  {string} cursor   Start/end cursor for pagination.
- * @param  {bool}   getNext  Whether to retrieve next set of posts (true) or previous set (false).
- * @param  {number} perPage  Number of posts per page.
- * @return {Object}          Object containing Apollo client instance and post archive data or error object.
+ * @param {string}  postType WP post type.
+ * @param {string}  orderBy  Order by: field.
+ * @param {string}  order    Order by: direction.
+ * @param {string}  cursor   Start/end cursor for pagination.
+ * @param {boolean} getNext  Whether to retrieve next set of posts (true) or previous set (false).
+ * @param {number}  perPage  Number of posts per page.
+ * @return {object}          Object containing Apollo client instance and post archive data or error object.
  */
 export default async function getPostTypeArchive(
   postType,

api/wordpress/_global/getPostTypeById.js

@@ -14,10 +14,10 @@ import queryTestimonialById from '../testimonials/queryTestimonialById'
  * Retrieve single post by specified identifier.
  *
  * @author WebDevStudios
- * @param  {string}        postType WP post type.
- * @param  {Number|string} id       Post identifier.
- * @param  {string}        idType   Type of ID.
- * @return {Object}                 Object containing Apollo client instance and post data or error object.
+ * @param {string}          postType WP post type.
+ * @param {number | string} id       Post identifier.
+ * @param {string}          idType   Type of ID.
+ * @return {object}                  Object containing Apollo client instance and post data or error object.
  */
 export default async function getPostTypeById(postType, id, idType = 'SLUG') {
   // Define single post query based on post type.

api/wordpress/_global/getPostTypeStaticPaths.js

@@ -6,8 +6,8 @@ import {initializeWpApollo} from '../connector'
  * Retrieve static paths by post type.
  *
  * @author WebDevStudios
- * @param  {string} postType WP post type.
- * @return {Object}          Post type paths.
+ * @param {string} postType WP post type.
+ * @return {object}         Post type paths.
  */
 export default async function getPostTypeStaticPaths(postType) {
   if (!postType || !isValidPostType(postType)) {

api/wordpress/_global/getPostTypeStaticProps.js

@@ -7,11 +7,9 @@ import {addApolloState} from '@/api/apolloConfig'
  * Retrieve static props by post type.
  *
  * @author WebDevStudios
- * @param  {string}  params      Post params (e.g., slug).
- * @param  {string}  postType    Post Type.
- * @param  {boolean} preview     Whether requesting preview of post.
- * @param  {?Object} previewData Post preview data.
- * @return {Object}              Object containing post props and revalidate setting.
+ * @param {string} params   Post params (e.g., slug).
+ * @param {string} postType Post Type.
+ * @return {object}         Object containing post props and revalidate setting.
  */
 export default async function getPostTypeStaticProps(
   params,

api/wordpress/_global/postTypes.js

@@ -19,8 +19,8 @@ export const hierarchicalPostTypes = ['page']
  * Check if post type is valid.
  *
  * @author WebDevStudios
- * @param  {string} postType WP post type.
- * @return {bool}            Whether provided post type is valid.
+ * @param {string} postType WP post type.
+ * @return {boolean}        Whether provided post type is valid.
  */
 export function isValidPostType(postType) {
   return Object.keys(postTypes).includes(postType)
@@ -30,8 +30,8 @@ export function isValidPostType(postType) {
  * Check if post type is hierarchical.
  *
  * @author WebDevStudios
- * @param  {string} postType WP post type.
- * @return {bool}            Whether provided post type is hierarchical.
+ * @param {string} postType WP post type.
+ * @return {boolean}        Whether provided post type is hierarchical.
  */
 export function isHierarchicalPostType(postType) {
   return hierarchicalPostTypes.includes(postType)

api/wordpress/connector.js

@@ -21,7 +21,7 @@ let wpApolloClient
  * @see https://www.apollographql.com/docs/react/api/core/ApolloClient/
  *
  * @author WebDevStudios
- * @return {Object} Apollo client instance.
+ * @return {object} Apollo client instance.
  */
 export function createWpApolloClient() {
   return new ApolloClient({
@@ -38,8 +38,8 @@ export function createWpApolloClient() {
  * Init Apollo for WP and merge with initial state.
  *
  * @author WebDevStudios
- * @param  {mixed} initialState Initial Apollo state.
- * @return {Object}             WP Apollo client instance.
+ * @param {*} initialState Initial Apollo state.
+ * @return {object}        WP Apollo client instance.
  */
 export function initializeWpApollo(initialState = null) {
   // Only run one instance of the Apollo client.