├── .gitignore ├── .prettierrc ├── .vscode └── launch.json ├── LICENSE ├── README.md ├── package-lock.json ├── package.json ├── public ├── demo.png ├── demo800x582.png ├── ext.dev.json ├── ext.json ├── favicon.ico ├── index.html ├── logo1080.png ├── logo192.png ├── logo512.png ├── manifest.json ├── package.json ├── robots.txt └── sample.ext.json ├── src ├── components │ ├── Editor.css │ ├── Editor.test.tsx │ ├── Editor.tsx │ ├── EditorInternal.tsx │ └── KanbanCardModal.tsx ├── index.scss ├── index.tsx ├── lib │ ├── convertStateToMarkdown.test.ts │ ├── convertStateToMarkdown.ts │ ├── helpers.ts │ ├── parseMarkdown.test.ts │ └── parseMarkdown.ts ├── logo.svg ├── mocks │ ├── boardWithComments.markdown │ ├── boardWithComments.ts │ ├── simpleBoard.markdown │ └── simpleBoard.ts ├── react-app-env.d.ts ├── reportWebVitals.ts ├── setupTests.ts └── stylesheets │ ├── dark.scss │ ├── main.scss │ └── print.scss ├── tsconfig.json └── types ├── editor.d.ts └── react-trello.d.ts /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | # Dev Env 107 | .idea 108 | 109 | #### Copied from Create React App #### 110 | 111 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 112 | 113 | # dependencies 114 | /node_modules 115 | /.pnp 116 | .pnp.js 117 | 118 | # testing 119 | /coverage 120 | 121 | # production 122 | /build 123 | 124 | # yalc 125 | .yalc 126 | yalc.lock 127 | 128 | # misc 129 | .DS_Store 130 | .env.local 131 | .env.development.local 132 | .env.test.local 133 | .env.production.local 134 | 135 | npm-debug.log* 136 | yarn-debug.log* 137 | yarn-error.log* 138 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "singleQuote": true 3 | } 4 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "name": "Chrome", 6 | "type": "chrome", 7 | "request": "launch", 8 | "url": "http://localhost:3001", 9 | "webRoot": "${workspaceFolder}/src", 10 | "sourceMapPathOverrides": { 11 | "webpack:///src/*": "${webRoot}/*" 12 | } 13 | } 14 | ] 15 | } 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kanban Editor for Standard Notes 2 | 3 | ![Kanban Icon](/public/demo.png) 4 | 5 | ## Introduction 6 | 7 | The Kanban Editor is an unofficial editor for [Standard Notes](https://standardnotes.org), 8 | a free, open-source, end-to-end encrypted notes app. 9 | 10 | It integrates [rcdexta/react-trello](https://github.com/rcdexta/react-trello), a Kanban board editor, 11 | and saves your notes in Markdown so that you can easily read them, export them to Listed, etc.. 12 | 13 | Because Standard Notes has [not yet implemented collaborative editing](https://standardnotes.com/help/50/can-i-collaborate-with-others-on-a-note), the main use case is for a personal Kanban board. 14 | However, I believe [private workspaces](https://standardnotes.com/help/80/what-are-private-workspaces) can be shared to enable asynchronous collaboration. 15 | 16 | NOTE: The file format is much more stable now, but it will continue to evolve. 17 | I plan to keep the file format backwards compatible. 18 | However, it is possible that changes will be required in the future that could cause incompatibilities with existing notes. 19 | If possible, I will provide a migration tool to convert your notes to the new format. 20 | 21 | ## Demo 22 | 23 | [Try out the demo here!](https://corvec.github.io/sn-kanban-editor/) 24 | Note that any changes you make will be lost when you close your browser tab. 25 | 26 | ## Installation 27 | 28 | 1. Open the Standard Notes web or desktop app. 29 | 2. In the lower left corner of the app, click **Extensions**. 30 | 3. In the lower right corner, click **Import Extension**. 31 | 4. In the input box appears, paste: 32 | 33 | ``` 34 | https://corvec.github.io/sn-kanban-editor/ext.json 35 | ``` 36 | 37 | 6. Confirm adding the Kanban Editor. 38 | 7. Create a new note. 39 | 8. Open the "Editor" menu and then select "Kanban Editor" 40 | 9. Add a lane, add some cards, and have fun! 41 | 42 | ## Features 43 | 44 | 1. Manage cards with titles, descriptions, and labels 45 | 2. Drag and drop the cards between different "lanes" 46 | 47 | ## Project Roadmap 48 | 49 | Please refer to the [Projects Roadmap](https://github.com/corvec/sn-kanban-editor/projects/1) 50 | for details on planned future development (if any). 51 | 52 | ## Development and Running Locally 53 | 54 | **Prerequisites:** 55 | 56 | 1. (Optional) Fork this repo on Github. 57 | 2. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this repo or your fork. 58 | 3. Run `cd sn-kanban-editor` and then `npm install` to install all dependencies. 59 | 60 | ### Testing in the browser 61 | 62 | 1. Run 63 | 64 | ``` 65 | npm start 66 | ``` 67 | 68 | 2. Your browser may open automatically. If not, open your browser and navigate to `http://localhost:3001/` 69 | 3. When you're done, in the console, press `ctrl/cmd + C` to stop running the app. 70 | 71 | ### Testing in your local Standard Notes app 72 | 73 | 1. An `ext.dev.json` file is already present in the public directory. You may wish to edit it. 74 | 2. To build the app, run 75 | 76 | ``` 77 | npm run build 78 | ``` 79 | 80 | 4. To serve the app, run 81 | 82 | ``` 83 | npm run server 84 | ``` 85 | 86 | 5. Install the editor into the [web](https://app.standardnotes.org) or 87 | [desktop](https://standardnotes.org/download) app by installing: 88 | 89 | ``` 90 | http://localhost:3000/ext.json 91 | ``` 92 | 93 | 6. When you're done, in the console, press `ctrl + C` to shut down the server. 94 | 95 | If you run into issues, please refer to the [StandardNotes instructions for local setup](https://docs.standardnotes.com/extensions/local-setup/) 96 | 97 | ### Deployment 98 | 99 | 1. Update the package.json version, the public/ext.json version, and the public/ext.dev.json version 100 | 2. Update the following command to account for the updates that you wish to deploy as well as the current version, then run it. 101 | 102 | ``` 103 | npx gh-pages -b gh-pages -d build -m "Support comments on cards (show modal on click)" -g "v0.4.0" 104 | ``` 105 | 106 | 3. On GitHub, create a new release corresponding to that tag. 107 | 108 | This project was forked from [StandardNotes/editor-template-cra-typescript](https://github.com/standardnotes/editor-template-cra-typescript), 109 | which was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). 110 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sn-kanban-editor", 3 | "version": "0.5.1", 4 | "description": "", 5 | "keywords": [ 6 | "Standard Notes", 7 | "Standard Notes Extensions", 8 | "Standard Notes Editors", 9 | "Kanban Boards", 10 | "Personal Kanban Board" 11 | ], 12 | "private": true, 13 | "license": "AGPL-3.0-or-later", 14 | "repository": { 15 | "type": "git", 16 | "url": "https://github.com/corvec/sn-kanban-editor.git" 17 | }, 18 | "bugs": { 19 | "url": "https://github.com/corvec/sn-kanban-editor/issues" 20 | }, 21 | "sn": { 22 | "main": "build/index.html" 23 | }, 24 | "homepage": ".", 25 | "scripts": { 26 | "analyze": "source-map-explorer 'build/static/js/*.js'", 27 | "start": "PORT=3001 react-scripts start", 28 | "build": "react-scripts build", 29 | "clean-deploy-cache": "rm -rf node_modules/.cache/gh-pages", 30 | "predeploy": "npm run build && npm run clean-deploy-cache", 31 | "deploy": "gh-pages -b gh-pages -d build", 32 | "test": "react-scripts test", 33 | "eject": "react-scripts eject", 34 | "serve": "serve -s -p 3000 build", 35 | "server-public": "http-server -p 3000 --cors", 36 | "server-root": "http-server ./ -p 3000 --cors", 37 | "server": "http-server ./build -p 3000 --cors", 38 | "pretty": "prettier --write 'src/**/*.{html,css,scss,js,jsx,ts,tsx,json}' README.md" 39 | }, 40 | "dependencies": { 41 | "@tabler/icons": "^1.39.1", 42 | "filesafe-embed": "^1.0.10", 43 | "filesafe-js": "^1.0.4", 44 | "lodash": "^4.17.20", 45 | "react": "^16.14.0", 46 | "react-dom": "16", 47 | "react-modal": "^3.12.1", 48 | "react-modal-hook": "^3.0.0", 49 | "react-redux": "^7.2.2", 50 | "react-trello": "^2.2.11", 51 | "redux": "^4.0.5", 52 | "redux-actions": "^2.6.5", 53 | "redux-logger": "^3.0.6", 54 | "sass": "^1.54.0", 55 | "sn-editor-kit": "1.0.6", 56 | "sn-stylekit": "2.1.0", 57 | "source-map-explorer": "^2.5.1", 58 | "styled-components": "^5.2.1", 59 | "uuid": "^8.3.2", 60 | "web-vitals": "^1.0.1" 61 | }, 62 | "devDependencies": { 63 | "@testing-library/dom": "^7.29.0", 64 | "@testing-library/jest-dom": "^5.11.6", 65 | "@testing-library/react": "^11.2.2", 66 | "@testing-library/user-event": "^12.6.0", 67 | "@types/jest": "^26.0.19", 68 | "@types/lodash": "^4.14.165", 69 | "@types/node": "^14.14.14", 70 | "@types/react": "^17.0.0", 71 | "@types/react-dom": "^17.0.0", 72 | "gh-pages": "^3.1.0", 73 | "http-server": "^14.1.1", 74 | "husky": "^4.3.6", 75 | "lint-staged": "^10.5.3", 76 | "prettier": "^2.2.1", 77 | "react-scripts": "^5.0.1", 78 | "typescript": "^4.1.3", 79 | "yalc": "^1.0.0-pre.50" 80 | }, 81 | "eslintConfig": { 82 | "extends": [ 83 | "react-app", 84 | "react-app/jest" 85 | ] 86 | }, 87 | "browserslist": { 88 | "production": [ 89 | ">0.2%", 90 | "not dead", 91 | "not op_mini all" 92 | ], 93 | "development": [ 94 | "last 1 chrome version", 95 | "last 1 firefox version", 96 | "last 1 safari version" 97 | ] 98 | }, 99 | "husky": { 100 | "hooks": { 101 | "pre-commit": "lint-staged" 102 | } 103 | }, 104 | "lint-staged": { 105 | "README.md": [ 106 | "prettier --write" 107 | ], 108 | "src/**/*.{js,jsx,ts,tsx,json,css,scss,md}": [ 109 | "prettier --write" 110 | ] 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /public/demo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/corvec/sn-kanban-editor/3391772559cfa97fad6be1274f49d071920d07f9/public/demo.png -------------------------------------------------------------------------------- /public/demo800x582.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/corvec/sn-kanban-editor/3391772559cfa97fad6be1274f49d071920d07f9/public/demo800x582.png -------------------------------------------------------------------------------- /public/ext.dev.json: -------------------------------------------------------------------------------- 1 | { 2 | "identifier": "org.corvec.sn-kanban-editor-dev", 3 | "name": "Kanban Editor (Dev)", 4 | "content_type": "SN|Component", 5 | "area": "editor-editor", 6 | "version": "0.5.1", 7 | "description": "DEV Kanban board editor for Standard Notes using react-trello", 8 | "url": "http://localhost:3000/index.html", 9 | "download_url": "", 10 | "latest_url": "http://localhost:3000/ext.dev.json", 11 | "marketing_url": "https://github.com/corvec/sn-kanban-editor", 12 | "thumbnail_url": "http://localhost:3000/logo512.png" 13 | } 14 | -------------------------------------------------------------------------------- /public/ext.json: -------------------------------------------------------------------------------- 1 | { 2 | "identifier": "org.corvec.sn-kanban-editor", 3 | "name": "Kanban Editor", 4 | "content_type": "SN|Component", 5 | "area": "editor-editor", 6 | "version": "0.5.1", 7 | "description": "Kanban board editor for Standard Notes using react-trello", 8 | "url": "https://corvec.github.io/sn-kanban-editor/index.html", 9 | "download_url": "https://github.com/corvec/sn-kanban-editor/archive/v0.5.1.zip", 10 | "latest_url": "https://corvec.github.io/sn-kanban-editor/ext.json", 11 | "marketing_url": "https://github.com/corvec/sn-kanban-editor", 12 | "thumbnail_url": "https://corvec.github.io/sn-kanban-editor/logo512.png" 13 | } 14 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/corvec/sn-kanban-editor/3391772559cfa97fad6be1274f49d071920d07f9/public/favicon.ico -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 12 | 16 | 17 | 26 | Editor Template 27 | 28 | 29 | 30 | 31 |
32 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /public/logo1080.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/corvec/sn-kanban-editor/3391772559cfa97fad6be1274f49d071920d07f9/public/logo1080.png -------------------------------------------------------------------------------- /public/logo192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/corvec/sn-kanban-editor/3391772559cfa97fad6be1274f49d071920d07f9/public/logo192.png -------------------------------------------------------------------------------- /public/logo512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/corvec/sn-kanban-editor/3391772559cfa97fad6be1274f49d071920d07f9/public/logo512.png -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "Editor Template", 3 | "name": "Editor Template CRA TypeScript", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | }, 10 | { 11 | "src": "logo192.png", 12 | "type": "image/png", 13 | "sizes": "192x192" 14 | }, 15 | { 16 | "src": "logo512.png", 17 | "type": "image/png", 18 | "sizes": "512x512" 19 | } 20 | ], 21 | "start_url": ".", 22 | "display": "standalone", 23 | "theme_color": "#000000", 24 | "background_color": "#ffffff" 25 | } 26 | -------------------------------------------------------------------------------- /public/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "standard-notes-editor-template-cra-typescript", 3 | "version": "0.1.0", 4 | "description": "Template for building editors for Standard Notes using Create React App and TypeScript", 5 | "keywords": [ 6 | "Standard Notes", 7 | "Standard Notes Extensions" 8 | ], 9 | "private": true, 10 | "license": "AGPL-3.0-or-later", 11 | "repository": { 12 | "type": "git", 13 | "url": "https://github.com/standardnotes/editor-template-cra-typescript.git" 14 | }, 15 | "bugs": { 16 | "url": "https://github.com/standardnotes/editor-template-cra-typescript/issues" 17 | }, 18 | "sn": { 19 | "main": "index.html" 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /public/robots.txt: -------------------------------------------------------------------------------- 1 | # https://www.robotstxt.org/robotstxt.html 2 | User-agent: * 3 | Disallow: 4 | -------------------------------------------------------------------------------- /public/sample.ext.json: -------------------------------------------------------------------------------- 1 | { 2 | "identifier": "org.standardnotes.editor-template-cra-typescript", 3 | "name": "Editor Template CRA Typescript", 4 | "content_type": "SN|Component", 5 | "area": "editor-editor", 6 | "version": "0.1.0", 7 | "description": "Template for building editors for Standard Notes using Create React App and TypeScript", 8 | "url": "http://localhost:3000/index.html", 9 | "download_url": "", 10 | "latest_url": "", 11 | "marketing_url": "https://github.com/standardnotes/editor-template-cra-typescript", 12 | "thumbnail_url": "" 13 | } 14 | -------------------------------------------------------------------------------- /src/components/Editor.css: -------------------------------------------------------------------------------- 1 | #sn-component .react-trello-board { 2 | background-color: var(--sn-stylekit-background-color); 3 | color: var(--sn-stylekit-foreground-color); 4 | } 5 | #sn-component .react-trello-lane { 6 | color: var(--sn-stylekit-contrast-foreground-color); 7 | border-color: var(--sn-stylekit-contrast-border-color); 8 | background-color: var(--sn-stylekit-contrast-background-color); 9 | } 10 | #sn-component .react-trello-lane > header textarea { 11 | color: var(--sn-stylekit-contrast-foreground-color); 12 | } 13 | /* Lane ellipsis */ 14 | #sn-component .react-trello-lane > header > div > a > button { 15 | color: var(--sn-stylekit-contrast-foreground-color); 16 | } 17 | 18 | #sn-component .react-trello-card { 19 | background-color: var(--sn-stylekit-secondary-background-color); 20 | color: var(--sn-stylekit-secondary-foreground-color); 21 | border-color: var(--sn-stylekit-secondary-border-color); 22 | } 23 | #sn-component .react-trello-card textarea { 24 | color: var(--sn-stylekit-secondary-foreground-color); 25 | } 26 | #sn-component .react-trello-card textarea:focus { 27 | color: var(--sn-stylekit-paragraph-text-color); 28 | background-color: var(--sn-stylekit-secondary-contrast-background-color); 29 | border-color: var(--sn-stylekit-input-border-color); 30 | } 31 | /* Card x button */ 32 | #sn-component .react-trello-card:hover > header > div > button { 33 | color: var(--sn-stylekit-secondary-foreground-color); 34 | } 35 | /* Click to add card */ 36 | #sn-component .react-trello-lane > a { 37 | color: var(--sn-stylekit-info-color); 38 | } 39 | #sn-component .react-trello-lane > a:hover { 40 | color: var(--sn-stylekit-neutral-color); 41 | } 42 | 43 | /* New Card form */ 44 | #sn-component .react-trello-lane > div > div:last-child { 45 | background-color: var(--sn-stylekit-secondary-background-color); 46 | color: var(--sn-stylekit-secondary-foreground-color); 47 | border-color: var(--sn-stylekit-secondary-border-color); 48 | } 49 | #sn-component .react-trello-lane > div > div:last-child article, 50 | #sn-component .react-trello-lane > div > div:last-child article header div, 51 | #sn-component .react-trello-lane > div > div:last-child article div div { 52 | background-color: var(--sn-stylekit-secondary-background-color); 53 | color: var(--sn-stylekit-secondary-foreground-color); 54 | } 55 | /* text while the input is active */ 56 | #sn-component .react-trello-lane > div > div:last-child article div:focus { 57 | color: var(--sn-stylekit-paragraph-text-color); 58 | } 59 | /* header when there is no text */ 60 | #sn-component 61 | .react-trello-lane 62 | > div 63 | > div:last-child 64 | article 65 | > header 66 | > span 67 | > div { 68 | background-color: var(--sn-stylekit-secondary-background-color); 69 | color: var(--sn-stylekit-secondary-foreground-color); 70 | } 71 | /* Add card button */ 72 | #sn-component .react-trello-lane > div > div:last-child button:first-of-type { 73 | background-color: var(--sn-stylekit-success-color); 74 | color: var(--sn-stylekit-success-contrast-color); 75 | border-color: var(--sn-stylekit-secondary-contrast-border-color); 76 | } 77 | /* Cancel button */ 78 | #sn-component .react-trello-lane > div > div:last-child button:last-of-type { 79 | background-color: var(--sn-stylekit-neutral-color); 80 | color: var(--sn-stylekit-neutral-contrast-color); 81 | border-color: var(--sn-stylekit-secondary-contrast-border-color); 82 | } 83 | 84 | /* Add another lane button and form */ 85 | /* Top level Button */ 86 | #sn-component .react-trello-board > div:last-of-type > section > button { 87 | border-color: var(--sn-stylekit-secondary-border-color); 88 | background-color: var(--sn-stylekit-info-color); 89 | color: var(--sn-stylekit-info-contrast-color); 90 | } 91 | /* Form */ 92 | #sn-component .react-trello-board > div:last-of-type > section { 93 | color: var(--sn-stylekit-contrast-foreground-color); 94 | border-color: var(--sn-stylekit-contrast-border-color); 95 | background-color: var(--sn-stylekit-contrast-background-color); 96 | } 97 | #sn-component .react-trello-board > div:last-of-type > section textarea { 98 | color: var(--sn-stylekit-contrast-foreground-color); 99 | background-color: var(--sn-stylekit-contrast-background-color); 100 | } 101 | #sn-component .react-trello-board > div:last-of-type > section textarea:focus { 102 | color: var(--sn-stylekit-paragraph-text-color); 103 | border-color: var(--sn-stylekit-info-color); 104 | background-color: var(--sn-stylekit-contrast-background-color); 105 | } 106 | /* Add lane button */ 107 | #sn-component 108 | .react-trello-board 109 | > div:last-of-type 110 | > section 111 | button:first-of-type { 112 | background-color: var(--sn-stylekit-success-color); 113 | color: var(--sn-stylekit-success-contrast-color); 114 | border-color: var(--sn-stylekit-secondary-contrast-border-color); 115 | } 116 | /* Cancel button */ 117 | #sn-component 118 | .react-trello-board 119 | > div:last-of-type 120 | > section 121 | button:last-of-type { 122 | background-color: var(--sn-stylekit-neutral-color); 123 | color: var(--sn-stylekit-neutral-contrast-color); 124 | border-color: var(--sn-stylekit-secondary-contrast-border-color); 125 | } 126 | 127 | /* Modal */ 128 | 129 | .ReactModalPortal .comment-remove-button svg { 130 | stroke: var(--sn-stylekit-neutral-contrast-color); 131 | fill: var(--sn-stylekit-neutral-color); 132 | } 133 | 134 | .ReactModalPortal .comment-remove-button:hover svg { 135 | stroke: var(--sn-stylekit-danger-contrast-color); 136 | fill: var(--sn-stylekit-danger-color); 137 | } 138 | -------------------------------------------------------------------------------- /src/components/Editor.test.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { render, screen } from '@testing-library/react'; 3 | import Editor from './Editor'; 4 | 5 | test('renders add another lane button', () => { 6 | render(); 7 | const addLaneButton = screen.getByText(/Add another lane/i); 8 | expect(addLaneButton).toBeInTheDocument(); 9 | }); 10 | -------------------------------------------------------------------------------- /src/components/Editor.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { EditorKit, EditorKitDelegate } from 'sn-editor-kit'; 3 | import { ModalProvider } from 'react-modal-hook'; 4 | import { KanbanBoard } from '../../types/react-trello'; 5 | import { infuseBoardData } from '../lib/helpers'; 6 | import { parseMarkdown } from '../lib/parseMarkdown'; 7 | import { convertStateToMarkdown } from '../lib/convertStateToMarkdown'; 8 | import './Editor.css'; 9 | import { EditorInterface } from '../../types/editor'; 10 | import { EditorInternal } from './EditorInternal'; 11 | 12 | const initialState: EditorInterface = { 13 | printUrl: false, 14 | boardData: { 15 | lanes: [], 16 | }, 17 | editorConfig: '', 18 | parsingErrors: [], 19 | }; 20 | 21 | let keyMap = new Map(); 22 | 23 | export default class Editor extends React.Component<{}, EditorInterface> { 24 | editorKit: any; 25 | 26 | constructor(props: EditorInterface) { 27 | super(props); 28 | this.configureEditorKit(); 29 | this.state = { 30 | ...initialState, 31 | ...props, 32 | }; 33 | } 34 | 35 | parseText(text: string): EditorInterface { 36 | // In the very first version of this editor, we saved the data as JSON. 37 | // However, we no longer save the data as JSON. 38 | // This may be removed at some point in the future. 39 | try { 40 | const data = JSON.parse(text); 41 | if (data.hasOwnProperty('lanes')) { 42 | console.log('Parsed data from JSON.'); 43 | return data; 44 | } 45 | } catch (err) { 46 | /* Do Nothing */ 47 | } 48 | try { 49 | return parseMarkdown(text); 50 | } catch { 51 | console.log('Could not parse data from Markdown.'); 52 | const textByLine = text.split('\n'); 53 | return { 54 | ...initialState, 55 | parsingErrors: textByLine.map((lineText, lineIndex) => ({ 56 | lineText, 57 | lineIndex, 58 | message: 'Complete Markdown parsing failure', 59 | })), 60 | }; 61 | } 62 | } 63 | 64 | configureEditorKit = () => { 65 | let delegate = new EditorKitDelegate({ 66 | /** This loads every time a different note is loaded */ 67 | setEditorRawText: (text: string) => { 68 | const newState = this.parseText(text); 69 | this.setState({ 70 | ...initialState, 71 | ...newState, 72 | }); 73 | }, 74 | clearUndoHistory: () => {}, 75 | getElementsBySelector: () => [], 76 | }); 77 | 78 | this.editorKit = new EditorKit({ 79 | delegate: delegate, 80 | mode: 'plaintext', 81 | supportsFilesafe: false, 82 | }); 83 | }; 84 | 85 | handleDataChange = (boardData: KanbanBoard) => { 86 | if (typeof boardData === 'string') { 87 | this.parseText(boardData); 88 | const newState = this.parseText(boardData); 89 | this.setState({ 90 | ...this.state, 91 | ...newState, 92 | }); 93 | console.log('Convert board data from markdown and infuse'); 94 | } else if (boardData.lanes.length === 0) { 95 | this.setState({ boardData }); 96 | } else if (boardData.lanes[0].id) { 97 | // The only time we should save is when a change ACTUALLY happened. 98 | this.setState({ boardData }); 99 | const markdown = convertStateToMarkdown({ 100 | ...this.state, 101 | boardData, 102 | }); 103 | this.saveNote(markdown); 104 | } else { 105 | // If the board was saved without IDs, we need to repopulate those IDs. 106 | // This should only happen when first loading a note. 107 | const infusedBoardData = infuseBoardData(boardData); 108 | this.setState({ boardData: infusedBoardData }); 109 | console.log('Infused board data'); 110 | } 111 | }; 112 | 113 | saveNote = (text: string) => { 114 | /** This will work in an SN context, but breaks the standalone editor, 115 | * so we need to catch the error 116 | */ 117 | try { 118 | this.editorKit.onEditorValueChanged(text); 119 | } catch (error) { 120 | console.log('Error saving note:', error); 121 | } 122 | }; 123 | 124 | onBlur = (e: React.FocusEvent) => {}; 125 | 126 | onFocus = (e: React.FocusEvent) => {}; 127 | 128 | onKeyDown = (e: React.KeyboardEvent | KeyboardEvent) => { 129 | keyMap.set(e.key, true); 130 | // Do nothing if 'Control' and 's' are pressed 131 | if (keyMap.get('Control') && keyMap.get('s')) { 132 | e.preventDefault(); 133 | } 134 | }; 135 | 136 | onKeyUp = (e: React.KeyboardEvent | KeyboardEvent) => { 137 | keyMap.delete(e.key); 138 | }; 139 | 140 | render() { 141 | return ( 142 | 143 | 148 | 149 | ); 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /src/components/EditorInternal.tsx: -------------------------------------------------------------------------------- 1 | import React, { useState } from 'react'; 2 | import Board from 'react-trello'; 3 | import ReactModal from 'react-modal'; 4 | import { KanbanCardModal } from './KanbanCardModal'; 5 | import { useModal } from 'react-modal-hook'; 6 | 7 | export enum HtmlElementId { 8 | board = 'board', 9 | snComponent = 'sn-component', 10 | } 11 | export enum HtmlClassName { 12 | board = 'board', 13 | snComponent = 'sn-component', 14 | } 15 | 16 | export const EditorInternal = ({ printUrl, boardData, handleDataChange }) => { 17 | const [card, setCard] = useState({ 18 | cardData: { 19 | title: '', 20 | description: '', 21 | label: '', 22 | comments: [], 23 | }, 24 | metadata: null, 25 | cardId: null, 26 | laneId: null, 27 | }); 28 | const [eventBus, setEventBus] = useState({ 29 | publish: (event) => console.log('not yet wired'), 30 | }); 31 | ReactModal.setAppElement(document.getElementById(HtmlElementId.snComponent)); 32 | const [showModal, hideModal] = useModal( 33 | () => ( 34 | { 38 | eventBus.publish({ 39 | type: 'UPDATE_CARD', 40 | laneId: card.laneId, 41 | card: { 42 | id: card.cardId, 43 | comments, 44 | }, 45 | }); 46 | }} 47 | /> 48 | ), 49 | [card] 50 | ); 51 | const openModal = (card) => { 52 | setCard(card); 53 | showModal(); 54 | }; 55 | return ( 56 |
61 | { 70 | const cardData = boardData.lanes 71 | .find((lane) => lane.id === laneId) 72 | .cards.find((card) => card.id === cardId); 73 | console.log(`Opening card in modal: ${JSON.stringify(cardData)}`); 74 | openModal({ cardId, cardData, metadata, laneId }); 75 | }} 76 | onDataChange={handleDataChange} 77 | /> 78 |
79 | ); 80 | }; 81 | -------------------------------------------------------------------------------- /src/components/KanbanCardModal.tsx: -------------------------------------------------------------------------------- 1 | import React, { useState } from 'react'; 2 | import ReactModal from 'react-modal'; 3 | import { IconMessage, IconCircleX } from '@tabler/icons'; 4 | 5 | const CardComment = ({ comment, deleteComment }) => ( 6 |
15 | 16 | {comment} 17 | 24 |
25 | ); 26 | 27 | const NoComments = () => ( 28 |
29 | No Comments yet... 30 |
31 | ); 32 | 33 | const customStyles = { 34 | content: { 35 | top: '50%', 36 | left: '50%', 37 | right: 'auto', 38 | bottom: 'auto', 39 | marginRight: '-50%', 40 | transform: 'translate(-50%, -50%)', 41 | backgroundColor: 'var(--sn-stylekit-contrast-background-color)', 42 | color: 'var(--sn-stylekit-contrast-foreground-color)', 43 | borderColor: 'var(--sn-stylekit-contrast-border-color)', 44 | borderWidth: '3px', 45 | }, 46 | }; 47 | 48 | export const KanbanCardModal = ({ card, hideModal, setComments }) => { 49 | const { title, description, label, comments } = card; 50 | const [newComment, setNewComment] = useState(''); 51 | const [updatedComments, setUpdatedComments] = useState(comments || []); 52 | const addComment = () => { 53 | setUpdatedComments([...updatedComments, newComment]); 54 | setNewComment(''); 55 | }; 56 | const deleteCommentByIndex = (index) => { 57 | setUpdatedComments(updatedComments.filter((_, i) => index !== i)); 58 | }; 59 | const closeModal = () => { 60 | setComments(updatedComments); 61 | hideModal(); 62 | }; 63 | 64 | return ( 65 | 66 |
67 | {title} 68 |
69 |
78 | {description} 79 |
80 |
81 | {updatedComments && updatedComments.length > 0 ? ( 82 | updatedComments.map((comment, i) => ( 83 | deleteCommentByIndex(i)} 87 | /> 88 | )) 89 | ) : ( 90 | 91 | )} 92 |
93 | setNewComment(e.target.value)} 97 | onKeyDown={(e) => { 98 | if (e.key === 'Enter') { 99 | addComment(); 100 | e.preventDefault(); 101 | } 102 | }} 103 | /> 104 | 105 |
106 | ); 107 | }; 108 | -------------------------------------------------------------------------------- /src/index.scss: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | font-family: var(--sn-stylekit-sans-serif-font); 4 | -webkit-font-smoothing: antialiased; 5 | -moz-osx-font-smoothing: grayscale; 6 | } 7 | 8 | code { 9 | font-family: var(--sn-stylekit-sans-serif-font); 10 | } 11 | -------------------------------------------------------------------------------- /src/index.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import './index.scss'; 4 | import reportWebVitals from './reportWebVitals'; 5 | 6 | import Editor from './components/Editor'; 7 | import './stylesheets/main.scss'; 8 | 9 | ReactDOM.render( 10 | 11 | 12 | , 13 | document.getElementById('root') 14 | ); 15 | 16 | // If you want to start measuring performance in your app, pass a function 17 | // to log results (for example: reportWebVitals(console.log)) 18 | // or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals 19 | reportWebVitals(); 20 | -------------------------------------------------------------------------------- /src/lib/convertStateToMarkdown.test.ts: -------------------------------------------------------------------------------- 1 | import { convertStateToMarkdown } from './convertStateToMarkdown'; 2 | import { KanbanBoard } from '../../types/react-trello'; 3 | import boardWithComments from '../mocks/boardWithComments'; 4 | import simpleBoard from '../mocks/simpleBoard'; 5 | import fs from 'fs/promises'; 6 | 7 | // const boardWithCommentsMarkdown = require('../mocks/boardWithComments.markdown'); 8 | // const simpleBoardMarkdown = require('../mocks/simpleBoard.markdown'); 9 | 10 | const defaultState = { 11 | editorConfig: {}, 12 | parsingErrors: [], 13 | }; 14 | 15 | test('converts simple board data', async () => { 16 | const boardData = simpleBoard; 17 | const simpleBoardMarkdown = await fs.readFile( 18 | './src/mocks/simpleBoard.markdown', 19 | 'utf8' 20 | ); 21 | const expectedOutput = simpleBoardMarkdown.trim(); 22 | const result = convertStateToMarkdown({ ...defaultState, boardData }); 23 | expect(result.trim()).toEqual(expectedOutput); 24 | }); 25 | 26 | test('converts JSON with cards with comments', async () => { 27 | const boardData: KanbanBoard = boardWithComments; 28 | // const boardWithCommentsMarkdown = require('../mocks/boardWithComments.markdown'); 29 | const boardWithCommentsMarkdown = await fs.readFile( 30 | './src/mocks/boardWithComments.markdown', 31 | 'utf8' 32 | ); 33 | const expectedResult = boardWithCommentsMarkdown.trim(); 34 | const result = convertStateToMarkdown({ ...defaultState, boardData }); 35 | expect(result.trim()).toEqual(expectedResult); 36 | }); 37 | -------------------------------------------------------------------------------- /src/lib/convertStateToMarkdown.ts: -------------------------------------------------------------------------------- 1 | import { KanbanBoard, KanbanCard } from '../../types/react-trello'; 2 | import { titleCase } from './helpers'; 3 | import { 4 | EditorConfig, 5 | EditorInterface, 6 | ParsingErrors, 7 | } from '../../types/editor'; 8 | 9 | export const convertStateToMarkdown = (state: EditorInterface): string => { 10 | const { boardData, editorConfig, parsingErrors } = state; 11 | 12 | const boardText = convertBoardData(boardData); 13 | const configText = convertEditorConfig(editorConfig); 14 | const errorText = convertParsingErrors(parsingErrors); 15 | return `${boardText}${configText}${errorText}`; 16 | }; 17 | 18 | const convertParsingErrors = (parsingErrors: ParsingErrors[]): string => { 19 | const errorText = parsingErrors.map((error) => error.lineText).join('\n'); 20 | return addNewlineIfNotEmpty(errorText); 21 | }; 22 | 23 | const convertEditorConfig = (config: EditorConfig): string => { 24 | const configText = ''; 25 | return addNewlineIfNotEmpty(configText); 26 | }; 27 | 28 | const convertBoardData = (boardData: KanbanBoard): string => { 29 | const boardText = boardData.lanes 30 | .map((lane) => `# ${lane.title}\n${convertCards(lane.cards)}`) 31 | .join('\n\n'); 32 | return addNewlineIfNotEmpty(boardText); 33 | }; 34 | 35 | const convertCards = (cards: Array): string => { 36 | const cardFields = ['description', 'label']; 37 | return cards 38 | .map((card) => { 39 | const fieldData = cardFields 40 | .map(fieldToMarkdown(card)) 41 | .filter((_) => _) 42 | .join('\n'); 43 | const commentData = (card.comments || []) 44 | .map((comment) => ` * ${comment}`) 45 | .join('\n'); 46 | return `* ${card.title}${fieldData && '\n'}${fieldData}${ 47 | commentData && '\n * Comments:\n' 48 | }${commentData}`; 49 | }) 50 | .join('\n'); 51 | }; 52 | 53 | const fieldToMarkdown = (card: KanbanCard) => (fieldName: string): string => 54 | card[fieldName] ? ` * ${titleCase(fieldName)}: ${card[fieldName]}` : null; 55 | 56 | const addNewlineIfNotEmpty = (text: string): string => { 57 | return text ? `${text}\n` : ''; 58 | }; 59 | -------------------------------------------------------------------------------- /src/lib/helpers.ts: -------------------------------------------------------------------------------- 1 | import { v4 as uuid } from 'uuid'; 2 | import { KanbanBoard, KanbanCard, KanbanLane } from '../../types/react-trello'; 3 | 4 | /** 5 | * Immutably removes a key from an object 6 | * @example 7 | * // returns { a: 1 } 8 | * removeFromObject('b')({ a: 1, b: 2 }) 9 | * 10 | * @param {string} key The key to remove 11 | * @param {object} obj The object to update 12 | * @returns {object} A copy of obj, with the named key removed 13 | */ 14 | export const removeFromObject = (key) => ({ [key]: _, ...otherEntities }) => ({ 15 | ...otherEntities, 16 | }); 17 | 18 | const cleanupBoardObj = (obj: T): T => 19 | removeFromObject('currentPage')( 20 | removeFromObject('laneId')(removeFromObject('id')(obj)) 21 | ) as T; 22 | 23 | export const cleanupBoardData = (boardData: KanbanBoard): KanbanBoard => ({ 24 | ...cleanupBoardObj(boardData), 25 | lanes: boardData.lanes.map((lane) => ({ 26 | ...cleanupBoardObj(lane), 27 | cards: lane.cards.map((card) => cleanupBoardObj(card)), 28 | })), 29 | }); 30 | 31 | export const infuseBoardData = (boardData: KanbanBoard): KanbanBoard => { 32 | return { 33 | ...boardData, 34 | lanes: boardData.lanes.map((lane: KanbanLane) => { 35 | const laneId = uuid(); 36 | return { 37 | ...lane, 38 | id: laneId, 39 | cards: lane.cards.map((card: KanbanCard) => ({ 40 | ...card, 41 | laneId, 42 | id: uuid(), 43 | })), 44 | }; 45 | }), 46 | }; 47 | }; 48 | 49 | const titleCaseWord = (text: string): string => 50 | text.replace(/\w/, (firstLetter) => firstLetter.toUpperCase()); 51 | 52 | export const titleCase = (text: string): string => 53 | text 54 | .split(' ') 55 | .map((word) => titleCaseWord(word.toLowerCase())) 56 | .join(' '); 57 | -------------------------------------------------------------------------------- /src/lib/parseMarkdown.test.ts: -------------------------------------------------------------------------------- 1 | import { KanbanBoard } from '../../types/react-trello'; 2 | import { parseMarkdown } from './parseMarkdown'; 3 | 4 | test('converts simple markdown file', () => { 5 | const input = `# Lane 1 6 | * Card 1 7 | * Description: desc 8 | * Label: label`; 9 | const expectedResult: KanbanBoard = { 10 | lanes: [ 11 | { 12 | title: 'Lane 1', 13 | cards: [{ title: 'Card 1', description: 'desc', label: 'label' }], 14 | }, 15 | ], 16 | }; 17 | const { boardData } = parseMarkdown(input); 18 | expect(boardData).toEqual(expectedResult); 19 | }); 20 | 21 | test('converts markdown with cards with comments', () => { 22 | const input = `# Lane 1 23 | * Card 1 24 | * Description: desc 25 | * Label: label 26 | * Comments: 27 | * Comment 1 28 | * Comment 2 29 | * Comment 3 30 | * Card 2 31 | * Description: desc 2 32 | * Label: label 2 33 | * Comments: 34 | * Comment 4 35 | * Comment 5 36 | 37 | # Lane 2 38 | * Card 3 39 | * Description: desc 3 40 | * Label: label 3 41 | * Comments: 42 | * Comment 6`; 43 | const expectedResult: KanbanBoard = { 44 | lanes: [ 45 | { 46 | title: 'Lane 1', 47 | cards: [ 48 | { 49 | title: 'Card 1', 50 | description: 'desc', 51 | label: 'label', 52 | comments: ['Comment 1', 'Comment 2', 'Comment 3'], 53 | }, 54 | { 55 | title: 'Card 2', 56 | description: 'desc 2', 57 | label: 'label 2', 58 | comments: ['Comment 4', 'Comment 5'], 59 | }, 60 | ], 61 | }, 62 | { 63 | title: 'Lane 2', 64 | cards: [ 65 | { 66 | title: 'Card 3', 67 | description: 'desc 3', 68 | label: 'label 3', 69 | comments: ['Comment 6'], 70 | }, 71 | ], 72 | }, 73 | ], 74 | }; 75 | const { boardData } = parseMarkdown(input); 76 | expect(boardData).toEqual(expectedResult); 77 | }); 78 | -------------------------------------------------------------------------------- /src/lib/parseMarkdown.ts: -------------------------------------------------------------------------------- 1 | import { KanbanBoard, KanbanCard } from '../../types/react-trello'; 2 | import { 3 | EditorConfig, 4 | EditorInterface, 5 | ParsingErrors, 6 | } from '../../types/editor'; 7 | 8 | enum Scope { 9 | Board = 'Board', 10 | Lane = 'Lane', 11 | Card = 'Card', 12 | Comments = 'Comments', 13 | Options = 'Options', 14 | } 15 | 16 | const defaultConfig = {}; 17 | 18 | /** 19 | * Parses our Markdown code and transforms it into a state object 20 | * @param {string} markdown 21 | * @return {EditorInterface} 22 | */ 23 | export const parseMarkdown = (markdown: string): EditorInterface => { 24 | const boardData: KanbanBoard = { 25 | lanes: [], 26 | }; 27 | const lines = markdown.split('\n'); 28 | let laneIndex = -1; // a value of -1 denotes that we aren't in a lane 29 | let cardIndex = -1; // or card 30 | let propIndex = -1; // or property 31 | let scope = Scope.Board; 32 | const editorConfig: EditorConfig = defaultConfig; 33 | const parsingErrors: ParsingErrors[] = []; 34 | 35 | for (let i = 0; i < lines.length; ++i) { 36 | const line = lines[i]; 37 | // eslint-disable-next-line no-loop-func 38 | const errorData = (message: string) => ({ 39 | message, 40 | lineIndex: i, 41 | laneIndex, 42 | cardIndex, 43 | lineText: line, 44 | }); 45 | 46 | if (!line) { 47 | if ( 48 | i === 0 || 49 | (parsingErrors.length > 0 && 50 | parsingErrors[parsingErrors.length - 1].lineIndex === i - 1) 51 | ) { 52 | parsingErrors.push(errorData('')); 53 | } 54 | continue; 55 | } 56 | if (line.startsWith('# ')) { 57 | laneIndex += 1; 58 | cardIndex = -1; 59 | scope = Scope.Lane; 60 | const lane = { title: line.slice(2), cards: [] }; 61 | boardData.lanes.push(lane); 62 | } else if (line.startsWith('* ')) { 63 | if (boardData.lanes.length === 0) { 64 | parsingErrors.push(errorData('Cannot add cards before adding lanes!')); 65 | } 66 | const card: KanbanCard = { title: line.slice(2) }; 67 | cardIndex += 1; 68 | scope = Scope.Card; 69 | boardData.lanes[laneIndex].cards.push(card); 70 | } else if (line.toLowerCase().startsWith(' * description: ')) { 71 | if (cardIndex < 0) { 72 | parsingErrors.push( 73 | errorData('Cannot add card fields before adding a card!') 74 | ); 75 | } 76 | boardData.lanes[laneIndex].cards[cardIndex].description = line.slice(17); 77 | } else if (line.toLowerCase().startsWith(' * label: ')) { 78 | if (cardIndex < 0) { 79 | parsingErrors.push( 80 | errorData('Cannot add card fields before adding a card!') 81 | ); 82 | } 83 | boardData.lanes[laneIndex].cards[cardIndex].label = line.slice(11); 84 | } else if (line.toLowerCase().startsWith(' * comments:')) { 85 | scope = Scope.Comments; 86 | boardData.lanes[laneIndex].cards[cardIndex].comments = []; 87 | } else if ( 88 | scope === Scope.Comments && 89 | line.toLowerCase().startsWith(' * ') 90 | ) { 91 | boardData.lanes[laneIndex].cards[cardIndex].comments.push(line.slice(6)); 92 | } else { 93 | parsingErrors.push(errorData('Cannot parse line')); 94 | } 95 | } 96 | return { 97 | boardData, 98 | editorConfig, 99 | parsingErrors, 100 | }; 101 | }; 102 | -------------------------------------------------------------------------------- /src/logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/mocks/boardWithComments.markdown: -------------------------------------------------------------------------------- 1 | # Lane 1 2 | * Card 1 3 | * Description: desc 4 | * Label: label 5 | * Comments: 6 | * Comment 1 7 | * Comment 2 8 | * Comment 3 9 | * Card 2 10 | * Description: desc 2 11 | * Label: label 2 12 | * Comments: 13 | * Comment 4 14 | * Comment 5 15 | 16 | # Lane 2 17 | * Card 3 18 | * Description: desc 3 19 | * Label: label 3 20 | * Comments: 21 | * Comment 6 22 | -------------------------------------------------------------------------------- /src/mocks/boardWithComments.ts: -------------------------------------------------------------------------------- 1 | import { KanbanBoard } from '../../types/react-trello'; 2 | 3 | const boardData: KanbanBoard = { 4 | lanes: [ 5 | { 6 | title: 'Lane 1', 7 | cards: [ 8 | { 9 | title: 'Card 1', 10 | description: 'desc', 11 | label: 'label', 12 | comments: ['Comment 1', 'Comment 2', 'Comment 3'], 13 | }, 14 | { 15 | title: 'Card 2', 16 | description: 'desc 2', 17 | label: 'label 2', 18 | comments: ['Comment 4', 'Comment 5'], 19 | }, 20 | ], 21 | }, 22 | { 23 | title: 'Lane 2', 24 | cards: [ 25 | { 26 | title: 'Card 3', 27 | description: 'desc 3', 28 | label: 'label 3', 29 | comments: ['Comment 6'], 30 | }, 31 | ], 32 | }, 33 | ], 34 | }; 35 | 36 | export default boardData; 37 | -------------------------------------------------------------------------------- /src/mocks/simpleBoard.markdown: -------------------------------------------------------------------------------- 1 | # Lane 1 2 | * Card 1 3 | * Description: desc 4 | * Label: label 5 | -------------------------------------------------------------------------------- /src/mocks/simpleBoard.ts: -------------------------------------------------------------------------------- 1 | import { KanbanBoard } from '../../types/react-trello'; 2 | 3 | const boardData: KanbanBoard = { 4 | lanes: [ 5 | { 6 | title: 'Lane 1', 7 | cards: [ 8 | { 9 | title: 'Card 1', 10 | description: 'desc', 11 | label: 'label', 12 | }, 13 | ], 14 | }, 15 | ], 16 | }; 17 | 18 | export default boardData; 19 | -------------------------------------------------------------------------------- /src/react-app-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /src/reportWebVitals.ts: -------------------------------------------------------------------------------- 1 | import { ReportHandler } from 'web-vitals'; 2 | 3 | const reportWebVitals = (onPerfEntry?: ReportHandler) => { 4 | if (onPerfEntry && onPerfEntry instanceof Function) { 5 | import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => { 6 | getCLS(onPerfEntry); 7 | getFID(onPerfEntry); 8 | getFCP(onPerfEntry); 9 | getLCP(onPerfEntry); 10 | getTTFB(onPerfEntry); 11 | }); 12 | } 13 | }; 14 | 15 | export default reportWebVitals; 16 | -------------------------------------------------------------------------------- /src/setupTests.ts: -------------------------------------------------------------------------------- 1 | // jest-dom adds custom jest matchers for asserting on DOM nodes. 2 | // allows you to do things like: 3 | // expect(element).toHaveTextContent(/react/i) 4 | // learn more: https://github.com/testing-library/jest-dom 5 | import '@testing-library/jest-dom'; 6 | import 'regenerator-runtime/runtime'; 7 | -------------------------------------------------------------------------------- /src/stylesheets/dark.scss: -------------------------------------------------------------------------------- 1 | @media (prefers-color-scheme: dark) { 2 | // This is the Midnight theme available here: 3 | // https://github.com/sn-extensions/midnight-theme 4 | // Licensed under AGPL-3.0 5 | :root { 6 | --primary-bg-color: #292937; 7 | --secondary-bg-color: #313142; 8 | --editor-bg-color: #202020; 9 | --border-color: #13131a; 10 | --ui-text-color: #d8d8d8; 11 | 12 | --sn-stylekit-info-color: #086dd6; 13 | --sn-stylekit-info-contrast-color: white; 14 | 15 | --sn-stylekit-neutral-color: #7c7c7c; 16 | --sn-stylekit-neutral-contrast-color: white; 17 | 18 | --sn-stylekit-success-color: #2b9612; 19 | --sn-stylekit-success-contrast-color: white; 20 | 21 | --sn-stylekit-warning-color: #f6a200; 22 | --sn-stylekit-warning-contrast-color: white; 23 | 24 | --sn-stylekit-danger-color: #f80324; 25 | --sn-stylekit-danger-contrast-color: white; 26 | 27 | --sn-desktop-titlebar-bg-color: var(--primary-bg-color); 28 | --sn-desktop-titlebar-border-color: var(--border-color); 29 | --sn-desktop-titlebar-ui-color: var(--ui-text-color); 30 | --sn-desktop-titlebar-ui-hover-color: var(--sn-stylekit-info-color); 31 | 32 | // StyleKit Vars 33 | --sn-stylekit-shadow-color: #20202b; 34 | 35 | --sn-stylekit-background-color: #20202b; 36 | --sn-stylekit-border-color: var(--border-color); 37 | --sn-stylekit-foreground-color: var(--ui-text-color); 38 | 39 | --sn-stylekit-contrast-background-color: var(--secondary-bg-color); 40 | --sn-stylekit-contrast-foreground-color: var(--ui-text-color); 41 | --sn-stylekit-contrast-border-color: var(--border-color); 42 | 43 | --sn-stylekit-secondary-background-color: #292937; 44 | --sn-stylekit-secondary-foreground-color: var(--ui-text-color); 45 | --sn-stylekit-secondary-border-color: var(--border-color); 46 | 47 | --sn-stylekit-secondary-contrast-background-color: #45445a; 48 | --sn-stylekit-secondary-contrast-foreground-color: var(--ui-text-color); 49 | --sn-stylekit-secondary-contrast-border-color: var(--border-color); 50 | 51 | --sn-stylekit-editor-background-color: var(--sn-stylekit-background-color); 52 | --sn-stylekit-editor-foreground-color: var(--sn-stylekit-foreground-color); 53 | 54 | --sn-stylekit-paragraph-text-color: var(--ui-text-color); 55 | 56 | --sn-stylekit-scrollbar-track-border-color: var(--border-color); 57 | --sn-stylekit-scrollbar-thumb-color: var(--sn-stylekit-info-color); 58 | } 59 | 60 | /* Adjust background color for Plain Textarea 61 | This improves readability / usability in dark modes. */ 62 | .sn-component .sk-input.contrast { 63 | background-color: var(--sn-stylekit-background-color); 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /src/stylesheets/main.scss: -------------------------------------------------------------------------------- 1 | @import '~sn-stylekit/dist/stylekit.css'; 2 | @import '~sn-stylekit/themes/titanium-theme/dist/dist.css'; 3 | 4 | @media screen and (max-width: 650px) { 5 | :root { 6 | --sn-stylekit-font-size-editor: 18px; 7 | } 8 | h1 { 9 | font-size: 1.75em; // is usually 2em 10 | } 11 | } 12 | 13 | body, 14 | html { 15 | background-color: var(--sn-stylekit-background-color); 16 | font-family: var(--sn-stylekit-sans-serif-font); 17 | font-size: var(--sn-stylekit-base-font-size); 18 | height: 100%; 19 | margin: 0; 20 | padding: 0; 21 | width: 100%; 22 | } 23 | 24 | * { 25 | // To prevent gray flash when focusing input on mobile Safari 26 | -webkit-tap-highlight-color: rgba(0, 0, 0, 0); 27 | } 28 | 29 | .sn-component { 30 | display: flex; 31 | flex-direction: column; 32 | font-size: var(--sn-stylekit-font-size-editor); 33 | min-height: 100vh; 34 | @media screen and (max-width: 420px) { 35 | min-height: fit-content; 36 | } 37 | 38 | textarea { 39 | padding: 9px 10px; 40 | max-width: inherit; 41 | width: calc(100% - 22px); 42 | resize: vertical; 43 | overflow-y: auto; 44 | font-family: var(--sn-stylekit-sans-serif-font); 45 | font-size: var(--sn-stylekit-font-size-editor); 46 | line-height: 1.7; 47 | } 48 | } 49 | 50 | a { 51 | color: var(--sn-stylekit-info-color); // #086dd6; 52 | text-decoration: none; 53 | } 54 | 55 | a:hover { 56 | text-decoration: underline; 57 | } 58 | 59 | code { 60 | box-sizing: border-box; 61 | word-wrap: break-word; 62 | padding: 0.2em 0.4em; 63 | margin: 0; 64 | font-size: 85%; 65 | background-color: var(--sn-stylekit-contrast-background-color); 66 | border-radius: 3px; 67 | } 68 | 69 | p { 70 | padding: 0px 1em; 71 | } 72 | 73 | @import './print.scss'; 74 | @import './dark.scss'; 75 | -------------------------------------------------------------------------------- /src/stylesheets/print.scss: -------------------------------------------------------------------------------- 1 | @media print { 2 | .print-url { 3 | a[href]:after { 4 | content: ' (' attr(href) ')'; 5 | } 6 | } 7 | 8 | .sn-component, 9 | textarea { 10 | outline: none; 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es6", 4 | "lib": ["dom", "dom.iterable", "esnext"], 5 | "allowJs": true, 6 | "skipLibCheck": true, 7 | "esModuleInterop": true, 8 | "allowSyntheticDefaultImports": true, 9 | "strict": false, 10 | "forceConsistentCasingInFileNames": true, 11 | "noFallthroughCasesInSwitch": true, 12 | "module": "esnext", 13 | "moduleResolution": "node", 14 | "resolveJsonModule": true, 15 | "isolatedModules": true, 16 | "noEmit": true, 17 | "jsx": "react-jsx", 18 | "typeRoots": ["./types", "./node_modules/@types"] 19 | }, 20 | "include": ["src"], 21 | "exclude": ["node_modules", "types"] 22 | } 23 | -------------------------------------------------------------------------------- /types/editor.d.ts: -------------------------------------------------------------------------------- 1 | import { KanbanBoard } from './react-trello'; 2 | 3 | declare module 'sn-kanban-editor'; 4 | 5 | export interface EditorInterface { 6 | printUrl?: boolean; 7 | boardData: KanbanBoard; 8 | editorConfig: EditorConfig; 9 | parsingErrors: ParsingErrors[]; 10 | } 11 | 12 | export interface EditorConfig {} 13 | 14 | export interface ParsingErrors { 15 | message: string; 16 | lineIndex: number; 17 | lineText: string; 18 | laneIndex?: number; 19 | cardIndex?: number; 20 | } 21 | -------------------------------------------------------------------------------- /types/react-trello.d.ts: -------------------------------------------------------------------------------- 1 | declare module 'react-trello'; 2 | 3 | export interface KanbanCard { 4 | id?: string; 5 | title: string; 6 | description?: string; 7 | label?: string; 8 | laneId?: string; 9 | comments?: Array; 10 | } 11 | export interface KanbanLane { 12 | id?: string; 13 | title: string; 14 | cards: Array; 15 | currentPage?: number; 16 | } 17 | export interface KanbanBoard { 18 | lanes: Array; 19 | } 20 | --------------------------------------------------------------------------------