Don't handle the theme anymore, only the theme's patterns #3

kienstra · 2023-01-11T21:05:51Z

What does this do?

Removes the theme from the data model. Instead, it uses patterns (previously .included_patterns).
Removes wp-modules/string-fixer/ and other modules that were FSE-specific.
Changes the get-theme endpoint to get-patterns, and their associated functions, like get_theme()
Refactors useThemeData() to be for patterns, not themes.

What doesn't this do

Change markup
Implement Mike's really nice designs

Testing steps

Might have to do rm -rf pattern-manager && git clone -b update/get-theme https://github.com/studiopress/pattern-manager
Of course, if you do that, push all of your local commits first
nvm use 14 && npm i && npm run dev
Create a new pattern
Add some content
Click 'Save' (might have to do this twice)
Reload the page
Expected: your new pattern appears with the edits you made

kienstra · 2023-01-11T22:46:44Z

wp-modules/app/js/src/enums.ts

-	template_part = 'template_parts',
-}
-
-export type PatternType = keyof typeof ThemePatternType;


This is such a nice one, it's hard to delete 😄

kienstra · 2023-01-13T19:37:20Z

wp-modules/api-data/api-data.php

+			'type'              => 'object',
+			'description'       => __( 'The patterns', 'pattern-manager' ),
+			'validate_callback' => function( $to_validate ) {
+				return is_array( $to_validate );


This would have been nice, but it didn't work:

'validate_callback' => 'is_array',

It doesn't have to be so specific

It only needs patterns from the active theme, not any theme.

kienstra · 2023-01-13T21:33:21Z

wp-modules/api-data/api-data.php

@@ -0,0 +1,140 @@
+<?php


Renamed from api-theme-data.php, as this is for patterns, not themes.

kienstra · 2023-01-13T21:44:43Z

wp-modules/app/app.php

 	return array(
 		'patterns'     => \PatternManager\PatternDataHandlers\get_patterns(),
-		'theme'        => \PatternManager\ThemeDataHandlers\get_theme( $current_theme_data['id'] ?? null ),


We don't need the whole theme anymore, just the patterns.

data is not an optional property, so we shouldn't need the ? operator.

kienstra · 2023-01-13T23:39:37Z

wp-modules/app/js/src/hooks/usePatterns.ts

+		} );
+	}
+
+	function savePatternsData() {


Renamed from saveThemeData()

kienstra · 2023-01-13T23:39:57Z

wp-modules/app/js/src/hooks/usePatterns.ts

+		return new Promise( ( resolve ) => {
+			setIsSaving( true );
+
+			fetch( patternmanager.apiEndpoints.savePatternsEndpoint, {


TODO for another PR: rename patternmanager to patternManager

kienstra · 2023-01-13T23:48:45Z

wp-modules/app/js/src/types.ts

-	template_parts?: string[];
-	tested_up_to: string;
-	text_domain: string;
-	theme_json_file?: { [ key: string ]: unknown };


Michael, sorry to delete the nice typing you did.

kienstra · 2023-01-13T23:50:58Z

...odules/pattern-post-type/js/src/components/PatternEditorSidebar/SidebarPanels/TitlePanel.tsx

-		// Try to prevent populating an empty title by only updating if the type is a pattern.
-		// Doing it this way should still catch an empty title if the user somehow passes one.
-		if ( postMeta?.type === 'pattern' ) {
+		if ( postMeta.title ) {


There's no postMeta.type anymore, as this editor only handles patterns, not templates.

kienstra · 2023-01-13T23:51:56Z

wp-modules/pattern-post-type/js/src/components/PatternEditorSidebar/index.tsx

-			{ postMeta?.type === 'template' ? (
-				<TemplateDetails postMeta={ postMeta } />
-			) : (
-				<>


This ternary isn't needed, as there's no postMeta.type anymore.

I just removed the ternary, without changing anything other than formatting.

kienstra · 2023-01-13T23:58:07Z

You were probably hoping for a PR before the 3-day weekend 🤣

Of course, no rush.

kienstra · 2023-01-17T03:22:29Z

wp-modules/app/js/src/components/PatternManagerApp/index.tsx

@@ -8,12 +8,11 @@ import React from 'react';
 import { patternmanager } from '../../globals';

 import PatternManagerContext from '../../contexts/PatternManagerContext';
-import PatternManagerSnackbarContext from '../../contexts/PatternManagerNoticeContext';
+import NoticeContext from '../../contexts/NoticeContext';


Just a renaming. The new name is more generic.

kienstra · 2023-01-17T03:24:29Z

...odules/pattern-post-type/js/src/components/PatternEditorSidebar/SidebarPanels/TitlePanel.tsx

@@ -42,15 +42,12 @@ export default function TitlePanel( {
 		);
 	}, [] );

-	/**
+	/*


Nitpick: this isn't a JSDoc, just a comment.

kienstra · 2023-01-17T03:25:19Z

wp-modules/pattern-post-type/js/src/hooks/useChangeWords.ts

@@ -3,43 +3,20 @@ import { PostMeta } from '../types';
 export default function useChangeWords( postMeta: PostMeta ) {
 	// Change the word "Publish" to "Save Pattern"
 	function changeWords( translation: string, text: string ) {
-		if ( postMeta?.type === 'pattern' ) {


There's no postMeta.type anymore, as we're not editing templates. Only patterns.

kienstra · 2023-01-17T18:14:26Z

wp-modules/app/js/src/hooks/useThemeData.ts

-} from '../types';
-import { ThemePatternType } from '../enums';
-
-export default function useThemeData(


Mainly moved to usePatterns(), and removed theme-only logic.

kienstra · 2023-01-17T18:16:17Z

wp-modules/app/js/src/components/PatternPreview/index.tsx

@@ -15,7 +15,7 @@ export default function PatternPreview( { url, scale }: Props ) {
 	const [ iframeRef, setIframeRef ] = useState<
 		HTMLIFrameElement | undefined
 	>( undefined );
-	patterns?.addRef( url, iframeRef );
+	patterns.addRef( url, iframeRef );


A nice thing about your TS typing is that we know which properties are guaranteed to be there.

mike-day

Excellent work, @kienstra!

This is a really nice cleanup. The model focuses specifically on patterns now, and it's much easier to find what's needed without the extraneous data.

Also, you resolved conflicts with the UI rough-in super fast!

mike-day · 2023-01-17T19:02:14Z

Nice!

kienstra · 2023-01-17T19:05:40Z

Hi @mike-day,

This is a really nice cleanup. The model focuses specifically on patterns now, and it's much easier to find what's needed without the extraneous data.

Thanks so much for your kind words and review!

kienstra added 7 commits January 11, 2023 15:02

Change get-theme endpoint to get-pattern

5455d77

Remove more theme functions

0d5ef54

Fix a PHP error from an undefined $theme_path

13922fb

Move more theme logic to simply patterns

931177d

Remove string-fixer module

04eeedf

Move pattern logic to patterns directory

427df8d

Pass patterns in the save request

9c1068c

Base automatically changed from update/simplify-pm-app to main January 11, 2023 22:21

kienstra added 3 commits January 11, 2023 16:33

Change useThemeData() to usePatterns()

7941973

Change more references of currentTheme to patterns

2c1df17

Commit wp-modules/api-data/, which I forgot to stage

6cebc6b

kienstra commented Jan 11, 2023

View reviewed changes

kienstra added 5 commits January 11, 2023 16:50

Fix prettier error

b0826c6

Validate that the patterns param is an array

24927da

Change references to theme to patterns

58601b3

Remove another unused function

0afbde6

Merge in main, resolve conflicts

eb72b2f

kienstra commented Jan 13, 2023

View reviewed changes

kienstra added 6 commits January 13, 2023 13:44

Simplify currentPattern assignment

67a403b

Make the currentPattern assignment a simple statement, not a ternary

e21cb20

Make currentPattern optional

09b9f91

Rename *SnackbarContext to NoticeContext

c44f0c9

It doesn't have to be so specific

Remove more unused helper functions

e9f729d

Simplify how this gets patterns

83bee48

It only needs patterns from the active theme, not any theme.

kienstra commented Jan 13, 2023

View reviewed changes

kienstra added 3 commits January 13, 2023 15:37

Remove a pass-through function

4c181fd

Move a hook under where it's used

7ed03f1

Change return type, remove since tag

b63408e

kienstra commented Jan 13, 2023

View reviewed changes

Remove needless ? in patterns?.data

44a1f3b

data is not an optional property, so we shouldn't need the ? operator.

kienstra commented Jan 13, 2023

View reviewed changes

wp-modules/app/js/src/hooks/usePatterns.ts

} );

}

function savePatternsData() {

Copy link

Contributor Author

kienstra Jan 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed from saveThemeData()

kienstra commented Jan 13, 2023

View reviewed changes

kienstra added 4 commits January 13, 2023 17:41

Simplify get_theme_pattern()

e2d9618

Update PHP DocBlock

97ec802

Remove unneeded function

602cd8c

Alphabetize return of usePatterns()

694bb31

kienstra commented Jan 13, 2023

View reviewed changes

Remove title property, as it's not the same across endpoints

9ab8115

kienstra marked this pull request as ready for review January 13, 2023 23:56

kienstra requested review from mike-day, dreamwhisper and johnstonphilip January 13, 2023 23:56

Fix phpcs error

4a11d18

kienstra changed the title ~~Don't handle handle the theme anymore, only the theme's patterns~~ Don't handle the theme anymore, only the theme's patterns Jan 14, 2023

kienstra commented Jan 17, 2023

View reviewed changes

mike-day mentioned this pull request Jan 17, 2023

Add the pattern grid with categories #6

Merged

6 tasks

kienstra added 2 commits January 17, 2023 12:07

Merge in main, resolve conflicts

70db8cb

Remove types that aren't needed

13c190b

kienstra commented Jan 17, 2023

View reviewed changes

mike-day approved these changes Jan 17, 2023

View reviewed changes

kienstra merged commit 9a91222 into main Jan 17, 2023

kienstra deleted the update/get-theme branch January 17, 2023 19:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Don't handle the theme anymore, only the theme's patterns #3

Don't handle the theme anymore, only the theme's patterns #3

kienstra commented Jan 11, 2023 •

edited

Loading

kienstra Jan 11, 2023

kienstra Jan 13, 2023

kienstra Jan 13, 2023

kienstra Jan 13, 2023

kienstra Jan 13, 2023

kienstra Jan 13, 2023

kienstra Jan 13, 2023

kienstra Jan 13, 2023

kienstra Jan 13, 2023 •

edited

Loading

kienstra commented Jan 13, 2023 •

edited

Loading

kienstra Jan 17, 2023 •

edited

Loading

kienstra Jan 17, 2023 •

edited

Loading

kienstra Jan 17, 2023

kienstra Jan 17, 2023

kienstra Jan 17, 2023

mike-day left a comment

mike-day commented Jan 17, 2023

kienstra commented Jan 17, 2023

Don't handle the theme anymore, only the theme's patterns #3

Don't handle the theme anymore, only the theme's patterns #3

Conversation

kienstra commented Jan 11, 2023 • edited Loading

What does this do?

What doesn't this do

Testing steps

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kienstra Jan 13, 2023 • edited Loading

Choose a reason for hiding this comment

kienstra commented Jan 13, 2023 • edited Loading

kienstra Jan 17, 2023 • edited Loading

Choose a reason for hiding this comment

kienstra Jan 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mike-day left a comment

Choose a reason for hiding this comment

mike-day commented Jan 17, 2023

kienstra commented Jan 17, 2023

kienstra commented Jan 11, 2023 •

edited

Loading

kienstra Jan 13, 2023 •

edited

Loading

kienstra commented Jan 13, 2023 •

edited

Loading

kienstra Jan 17, 2023 •

edited

Loading

kienstra Jan 17, 2023 •

edited

Loading