Skip to content

Commit 19780e4

Browse files
cblanqueracblanquera
committed
tailwind plugin
1 parent c587b5a commit 19780e4

File tree

10 files changed

+355
-50
lines changed

10 files changed

+355
-50
lines changed

‎examples/with-tailwind/src/index.ts

+12-48
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,27 @@
1-
import type { DocumentBuilder } from '@ossph/temple/compiler';
2-
import type { Config } from 'tailwindcss';
31
import path from 'path';
42
import http from 'http';
5-
import postcss from 'postcss';
6-
import autoprefixer from 'autoprefixer';
7-
import tailwindcss from 'tailwindcss';
83
import temple from '@ossph/temple/compiler';
94
import { dev } from '@ossph/temple-dev';
10-
11-
const config = {
12-
darkMode: 'class',
13-
theme: { extend: {} },
14-
plugins: []
15-
};
5+
import { tailwind } from '@ossph/temple-tailwind';
166

177
const assets = path.resolve(__dirname, '../public');
188

199
//create temple compiler
2010
const compiler = temple({ cwd: __dirname });
11+
12+
compiler.use(tailwind({
13+
darkMode: 'class',
14+
theme: { extend: {} },
15+
plugins: [],
16+
content: []
17+
}));
18+
19+
2120
const { router, refresh } = dev({
2221
cwd: __dirname,
2322
emitter: compiler.emitter
2423
});
2524

26-
compiler.emitter.on('dev-updated-component', async e => {
27-
const { document, updates } = e.params;
28-
updates[e.params.document.id].push(`;(() => {
29-
const links = Array.from(document.head.querySelectorAll('link'));
30-
const stylesheet = links.find(link => link.href.includes('${document.id}.css'));
31-
if (!stylesheet) {
32-
return;
33-
}
34-
stylesheet.href = stylesheet.href.replace(/\\?\\d+$/, '?' + Date.now());
35-
})();`);
36-
});
37-
38-
compiler.emitter.on('built-styles', async e => {
39-
const { document } = e.params.builder as DocumentBuilder;
40-
const sourceCode = e.params.sourceCode as string;
41-
//if there is a tailwind directive
42-
if (!sourceCode.includes('@tailwind')) {
43-
return;
44-
}
45-
//find all the components
46-
const content = Object.values(document.registry).map(
47-
component => component.absolute
48-
);
49-
//add the document to the content
50-
content.push(document.absolute);
51-
const css = postcss([ autoprefixer, tailwindcss({
52-
...config,
53-
content
54-
} as Config)]);
55-
const styles = await css.process(sourceCode, {
56-
from: undefined
57-
});
58-
e.params.sourceCode = styles.css;
59-
e.set(styles.css);
60-
});
61-
6225
const server = http.createServer(async (req, res) => {
6326
//if development route
6427
if (router(req, res)) return;
@@ -87,7 +50,7 @@ const server = http.createServer(async (req, res) => {
8750
return;
8851
} else if (req.url?.startsWith('/build/')) {
8952
//get filename ie. abc123.js
90-
const filename = req.url.substring(7);
53+
const filename = req.url.substring(7).split('?')[0];
9154
//get asset
9255
const { type, content } = await compiler.asset(filename);
9356
//send response
@@ -108,4 +71,5 @@ const server = http.createServer(async (req, res) => {
10871
res.statusCode = 404;
10972
res.end('Not Found');
11073
});
74+
11175
server.listen(3000);

‎package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@
55
"packages/*"
66
],
77
"scripts": {
8-
"build:packages": "yarn build:temple && yarn build:esbuild && yarn build:loader && yarn build:dev && yarn build:express && yarn build:ui && yarn build:web",
8+
"build:packages": "yarn build:temple && yarn build:esbuild && yarn build:loader && yarn build:dev && yarn build:express && yarn build:tailwind && yarn build:ui && yarn build:web",
99
"build:temple": "yarn --cwd packages/temple build",
1010
"build:esbuild": "yarn --cwd packages/temple-esbuild build",
1111
"build:loader": "yarn --cwd packages/temple-loader build",
1212
"build:dev": "yarn --cwd packages/temple-dev build",
1313
"build:express": "yarn --cwd packages/temple-express build",
14+
"build:tailwind": "yarn --cwd packages/temple-tailwind build",
1415
"build:ui": "yarn --cwd packages/temple-ui-src build",
1516
"build:web": "yarn --cwd packages/temple-web build",
1617
"test": "yarn --cwd packages/temple test",

‎packages/temple-tailwind/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2025 Chris Blanquera
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/temple-tailwind/README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# ⛩️ Temple Tailwind
2+
3+
This package is designed for [Temple](https://github.com/OSSPhilippines/temple),
4+
the reactive web component template engine. See [docs](https://github.com/OSSPhilippines/temple)
5+
for more information.
6+
7+
TailwindCSS support for the Temple markup language.
8+
9+
## Install
10+
11+
```bash
12+
$ npm -i @ossph/temple-tailwind
13+
```
14+
15+
## Usage
16+
17+
```js
18+
import temple from '@ossph/temple/compiler';
19+
import { tailwind } from '@ossph/temple-tailwind';
20+
21+
//create temple compiler
22+
const compiler = temple({ cwd: __dirname });
23+
//and use tailwind...
24+
compiler.use(tailwind({
25+
darkMode: 'class',
26+
theme: { extend: {} },
27+
plugins: [],
28+
content: []
29+
}));
30+
```

‎packages/temple-tailwind/index.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export * from './dist/index'

‎packages/temple-tailwind/index.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
...require('./dist/index')
3+
}

‎packages/temple-tailwind/package.json

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"name": "@ossph/temple-tailwind",
3+
"version": "0.1.3",
4+
"description": "Webpack support for the Temple markup language.",
5+
"license": "Apache-2.0",
6+
"author": "Chris <[email protected]>",
7+
"homepage": "https://github.com/OSSPhilippines/temple",
8+
"bugs": "https://github.com/OSSPhilippines/temple/issues",
9+
"repository": "OSSPhilippines/temple",
10+
"main": "dist/index.js",
11+
"files": [
12+
"dist",
13+
"index.d.ts",
14+
"index.js",
15+
"LICENSE",
16+
"README.md",
17+
"tsconfig.json"
18+
],
19+
"scripts": {
20+
"build": "tsc"
21+
},
22+
"dependencies": {
23+
"@ossph/temple": "0.1.3"
24+
},
25+
"peerDependencies": {
26+
"autoprefixer": "^10",
27+
"postcss": "^8",
28+
"tailwindcss": "^3"
29+
},
30+
"devDependencies": {
31+
"@types/node": "22.1.0",
32+
"typescript": "5.5.4"
33+
}
34+
}

0 commit comments

Comments
 (0)