Какую структуру папок и файлов рекомендуется использовать при работе с Timber? - PullRequest
0 голосов

Я недавно начал учиться создавать веб-страницы и пользовательские темы с Wordpress, используя Timber, Twig и Advanced Custom Fields, и я действительно не знаю, как все организовать. До сих пор я возился со всем в одном и том же месте (разделены .php и .twig), но я действительно вижу, что это становится беспорядком.

1 Ответ

0 голосов
/ 05 мая 2018

Так что ответ на этот вопрос, очевидно, очень субъективен. Не существует соглашения о том, как лучше организовать вашу папку, файлы и проект / тему. Отличной отправной точкой является тема Timber Starter, созданная людьми, которые делают Timber. Вы можете найти это здесь: https://github.com/timber/starter-theme

Я также собираюсь поделиться с вами проектом, который я недавно завершил с Timber, и показать вам, как он организован. К сожалению, я не могу поделиться с вами репо, как это было для работы, и репозиторий является частным, однако структура файлов и папок - это все, что действительно имеет значение.

Я начал этот проект и все проекты Timber со стартовой темой Timber, так что это моя отправная точка. Внутри папки Templates у меня есть следующее

CPT = обозначает пользовательские типы сообщений. У каждого CPT есть собственная папка внутри этой папки, и все мои файлы .twig для этого конкретного CPT идут туда. Например: CPT> Staff> image.twig, biography.twig и т. Д.

компоненты = этот файл содержит такие вещи, как верхний колонтитул, нижний колонтитул, навигация, мобильная навигация и т. Д. Все эти файлы .twig используются на разных страницах моего сайта.

страниц = эта папка содержит папки для каждой страницы. Мне нравится разбивать каждую страницу конкретно на «компоненты» и помещать каждый компонент, относящийся к конкретной странице, в его папку, относящуюся к конкретной странице.

Например, внутри этой папки страниц у меня есть папка с именем "home-page". Он содержит все компоненты для домашней страницы. Поэтому у меня может быть файл hero.twig, home-page-slider.twig, mission-Statement.twig и т. Д. Я разбиваю каждый фрагмент / компонент домашней страницы и создаю для каждого из них отдельный файл .twig и помещаю их в эту папку. ,

Я повторяю этот процесс для каждой настраиваемой страницы / шаблона, который я создаю.

Вот и все, по крайней мере, для этого проекта. Я надеюсь, что это дает вам общее представление о том, как лучше организовать ваши файлы. Главное, делать то, что имеет для вас смысл, и если вы работаете как команда, то, о чем вы и ваши коллеги по команде соглашаетесь.

Например, вы можете захотеть переименовать то, что я назвал моей папкой «компоненты», в «частичные», так как вы, возможно, более знакомы с этой терминологией. Честно говоря, не имеет значения, что вы делаете, до тех пор, пока это имеет смысл для вас, и кто бы ни был в этой базе кода. Помните, что имеет смысл сейчас, может не иметь смысла от 6 месяцев до года. Так что подумайте тоже.

То, как я подхожу ко всему этому, - это самый простой способ передать роль каждого файла. Я не должен думать или смотреть на readme. Имена файлов, имена папок и структура должны быть как можно более понятными. Мне нравится напоминать себе о принципе ПОЦЕЛУЯ в этих ситуациях ... "Держите это просто глупо!"

https://en.wikipedia.org/wiki/KISS_principle

Надеюсь, это поможет.

...