From 2fc5cf25fc80534c076d9c9b985ded283409c84e Mon Sep 17 00:00:00 2001 From: igorjrd Date: Fri, 3 Jan 2025 02:46:13 -0300 Subject: [PATCH 1/6] refactor: change resouces path --- .gitmodules | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitmodules b/.gitmodules index 850e333..8aa3a85 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ -[submodule "src/resources/locales"] - path = src/resources/locales +[submodule "resources/locales"] + path = resources/locales url = https://github.com/citation-style-language/locales From 2ca2e217c9583b842ca59fffaa99b3e57ef92830 Mon Sep 17 00:00:00 2001 From: igorjrd Date: Tue, 21 Apr 2026 14:42:08 -0300 Subject: [PATCH 2/6] refactor: source migration to TypeScript --- .gitignore | 8 +- .vscode-test.js | 3 + .vscode/launch.json | 12 +- .vscodeignore | 14 +- CHANGELOG.md | 7 + LICENSE.txt | 675 + README.md | 5 + dev/send-message-to-zotero-command.ts | 27 + dev/zotero/context-registry.ts | 22 + dev/zotero/handlers/get-active-doc-handler.ts | 18 + .../handlers/get-document-data-handler.ts | 13 + dev/zotero/io.ts | 41 + dev/zotero/models/document-context.ts | 29 + dev/zotero/models/document-field.ts | 29 + dev/zotero/processor-command-handler.ts | 124 + dev/zotero/zotero-client.ts | 38 + dev/zotero/zotero-server-command-handler.ts | 4 + dev/zotero/zotero-server-commands.ts | 4 + esbuild.js | 59 + l10n/bundle.l10n.pt-br.json | 16 + {src/resources => libs}/csl-validator.js | 0 package-lock.json | 13215 +++++++++++++--- package.json | 32 +- package.nls.json | 14 +- package.nls.pt-br.json | 14 +- .../csl-schema.json | 0 .../example_items.json | 0 src/client/crossref/crossref-client.ts | 28 + src/commands/choose-locale-command.ts | 31 + src/commands/command.ts | 3 + .../citables-supplying-strategy-proxy.ts | 19 + .../citables-supplying-strategy.ts | 7 + .../supply-default-documents-strategy.ts | 40 + .../supply-document-from-doi-strategy.ts | 21 + .../supply-documents-from-json-strategy.ts | 31 + src/commands/refresh-preview-command.ts | 16 + src/commands/show-preview-command.ts | 62 + src/commands/show-source-command.ts | 21 + src/constants/command-keys.ts | 8 + src/constants/configuration-keys.ts | 7 + src/constants/context-keys.ts | 6 + src/constants/messages.ts | 14 + src/csl-engine.js | 118 - src/error/doi-not-found-error.ts | 9 + .../active-text-editor-change-listener.ts | 22 + .../auto-refresh-document-change-listener.ts | 48 + .../auto-refresh-setting-change-listener.ts | 26 + src/events/base-listener.ts | 18 + src/events/listener.ts | 4 + src/events/text-document-close-listener.ts | 22 + src/events/webview-dispose-listener.ts | 39 + .../webview-view-state-change-listener.ts | 20 + src/extension-commander.js | 107 - src/extension.js | 29 - src/extension.ts | 33 + src/locale-bar.js | 12 - src/models/citable.ts | 5 + .../citeproc-preview-resource-retriever.ts | 28 + src/models/optional.ts | 40 + src/models/preview.ts | 71 + src/nls.js | 27 - src/preview-controller.js | 92 - src/preview-panel.js | 30 - src/previews-manager.js | 93 - src/resources/locales | 1 - src/services/command-service.ts | 27 + src/services/configuration-service.ts | 22 + src/services/context-service.ts | 28 + src/services/csl-service.ts | 119 + src/services/disposable-registry.ts | 24 + src/services/doi-service.ts | 35 + src/services/lifecycle-service.ts | 20 + src/services/localebar-service.ts | 31 + src/services/preview-service.ts | 73 + src/services/webview-service.ts | 28 + src/teste_subengine.js | 37 - src/types/citeproc.d.ts | 115 + src/types/csl-validator.d.ts | 3 + src/utils.js | 62 - src/utils/io-utils.ts | 12 + test/runTest.ts | 18 + test/suite/crossref.test.ts | 17 + test/suite/extension.test.ts | 142 + test/suite/fixtures.ts | 3 + test/suite/index.ts | 44 + test/suite/validator.test.ts | 14 + tsconfig.json | 20 + 87 files changed, 13988 insertions(+), 2537 deletions(-) create mode 100644 .vscode-test.js create mode 100644 LICENSE.txt create mode 100644 dev/send-message-to-zotero-command.ts create mode 100644 dev/zotero/context-registry.ts create mode 100644 dev/zotero/handlers/get-active-doc-handler.ts create mode 100644 dev/zotero/handlers/get-document-data-handler.ts create mode 100644 dev/zotero/io.ts create mode 100644 dev/zotero/models/document-context.ts create mode 100644 dev/zotero/models/document-field.ts create mode 100644 dev/zotero/processor-command-handler.ts create mode 100644 dev/zotero/zotero-client.ts create mode 100644 dev/zotero/zotero-server-command-handler.ts create mode 100644 dev/zotero/zotero-server-commands.ts create mode 100644 esbuild.js create mode 100644 l10n/bundle.l10n.pt-br.json rename {src/resources => libs}/csl-validator.js (100%) rename src/resources/csl-data.json => resources/csl-schema.json (100%) rename {src/resources => resources}/example_items.json (100%) create mode 100644 src/client/crossref/crossref-client.ts create mode 100644 src/commands/choose-locale-command.ts create mode 100644 src/commands/command.ts create mode 100644 src/commands/preview_citables_supplier/citables-supplying-strategy-proxy.ts create mode 100644 src/commands/preview_citables_supplier/citables-supplying-strategy.ts create mode 100644 src/commands/preview_citables_supplier/supply-default-documents-strategy.ts create mode 100644 src/commands/preview_citables_supplier/supply-document-from-doi-strategy.ts create mode 100644 src/commands/preview_citables_supplier/supply-documents-from-json-strategy.ts create mode 100644 src/commands/refresh-preview-command.ts create mode 100644 src/commands/show-preview-command.ts create mode 100644 src/commands/show-source-command.ts create mode 100644 src/constants/command-keys.ts create mode 100644 src/constants/configuration-keys.ts create mode 100644 src/constants/context-keys.ts create mode 100644 src/constants/messages.ts delete mode 100644 src/csl-engine.js create mode 100644 src/error/doi-not-found-error.ts create mode 100644 src/events/active-text-editor-change-listener.ts create mode 100644 src/events/auto-refresh-document-change-listener.ts create mode 100644 src/events/auto-refresh-setting-change-listener.ts create mode 100644 src/events/base-listener.ts create mode 100644 src/events/listener.ts create mode 100644 src/events/text-document-close-listener.ts create mode 100644 src/events/webview-dispose-listener.ts create mode 100644 src/events/webview-view-state-change-listener.ts delete mode 100644 src/extension-commander.js delete mode 100644 src/extension.js create mode 100644 src/extension.ts delete mode 100644 src/locale-bar.js create mode 100644 src/models/citable.ts create mode 100644 src/models/citeproc-preview-resource-retriever.ts create mode 100644 src/models/optional.ts create mode 100644 src/models/preview.ts delete mode 100644 src/nls.js delete mode 100644 src/preview-controller.js delete mode 100644 src/preview-panel.js delete mode 100644 src/previews-manager.js delete mode 160000 src/resources/locales create mode 100644 src/services/command-service.ts create mode 100644 src/services/configuration-service.ts create mode 100644 src/services/context-service.ts create mode 100644 src/services/csl-service.ts create mode 100644 src/services/disposable-registry.ts create mode 100644 src/services/doi-service.ts create mode 100644 src/services/lifecycle-service.ts create mode 100644 src/services/localebar-service.ts create mode 100644 src/services/preview-service.ts create mode 100644 src/services/webview-service.ts delete mode 100644 src/teste_subengine.js create mode 100644 src/types/citeproc.d.ts create mode 100644 src/types/csl-validator.d.ts delete mode 100644 src/utils.js create mode 100644 src/utils/io-utils.ts create mode 100644 test/runTest.ts create mode 100644 test/suite/crossref.test.ts create mode 100644 test/suite/extension.test.ts create mode 100644 test/suite/fixtures.ts create mode 100644 test/suite/index.ts create mode 100644 test/suite/validator.test.ts create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore index c6c5429..b228edf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ node_modules/ -jsconfig.json -.eslintrc.json -test/ \ No newline at end of file +.vscode-test/ +out/ +dist/ +package-lock.json +*.vsix \ No newline at end of file diff --git a/.vscode-test.js b/.vscode-test.js new file mode 100644 index 0000000..1b956be --- /dev/null +++ b/.vscode-test.js @@ -0,0 +1,3 @@ +const { defineConfig } = require('@vscode/test-cli'); + +module.exports = defineConfig({ files: 'out/src/test/**/*.test.js' }); \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json index 6899e23..437292b 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -11,8 +11,10 @@ "request": "launch", "runtimeExecutable": "${execPath}", "args": [ - "--extensionDevelopmentPath=${workspaceFolder}" - ] + "--extensionDevelopmentPath=${workspaceFolder}", + "--disable-extensions" + ], + "preLaunchTask": "npm: compile" }, { "name": "Extension Tests", @@ -21,8 +23,10 @@ "runtimeExecutable": "${execPath}", "args": [ "--extensionDevelopmentPath=${workspaceFolder}", - "--extensionTestsPath=${workspaceFolder}/test/suite/index" - ] + "--extensionTestsPath=${workspaceFolder}/dist/test/suite/index", + "--disable-extensions" + ], + "preLaunchTask": "npm: compile", } ] } diff --git a/.vscodeignore b/.vscodeignore index 2f361b0..3de9aff 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -1,8 +1,14 @@ +tsconfig.json +esbuild.js +.vscode-test.js +src/ +out/ +test/ +node_modules/ .vscode/** .vscode-test/** -test/** .gitignore -vsc-extension-quickstart.md -**/jsconfig.json +.gitmodules **/*.map -**/.eslintrc.json +**/*.ts +media/*.gif diff --git a/CHANGELOG.md b/CHANGELOG.md index 97ab5ae..da96123 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Change Log +### 1.0.0 + +* Extension source language switched to TypeScript +* Major code refactoring +* Implemented ESBuild extension bundling +* Extension tests suite included + ### 0.2.2 * Fixes [issue 12](https://github.com/igorjrd/vscode-cslpreview/issues/12) diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..229983e --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + VSCode CSL Preview is an Visual Studio Code extension that enable users + pre visualize bibliographic formatted data according a CSL source + Copyright (C) 2026 Igor Jordão + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see https://www.gnu.org/licenses/. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + VSCode CSL Preview Copyright (C) 2026 Igor Jordão + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 49e59da..3f4a03e 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,11 @@ There is no know issues at the moment. If you experience trobles when using the ## Release Notes +### 1.0.0 + +* Extension source language switched to TypeScript +* Major code refactoring + ### 0.2.2 * Fixes [issue 12](https://github.com/igorjrd/vscode-cslpreview/issues/12) diff --git a/dev/send-message-to-zotero-command.ts b/dev/send-message-to-zotero-command.ts new file mode 100644 index 0000000..48ba9c5 --- /dev/null +++ b/dev/send-message-to-zotero-command.ts @@ -0,0 +1,27 @@ +// import * as vscode from "vscode"; +// import ZoteroClient from "../client/zotero/zotero-client"; +// import Command from "../commands/command"; + +// export default class SendMessageToZoteroCommand implements Command { +// client: ZoteroClient; + +// constructor(client: ZoteroClient) { +// this.client = client; +// } + +// execute(): void { +// vscode.window.showInputBox({prompt: "ID"}) +// .then((input) => { +// if (input == null || input ==undefined) +// return; +// let id = Number.parseInt(input); +// vscode.window.showInputBox({prompt: "Mensagem"}) +// .then((input2) => { +// if (input2 == null || input ==undefined) +// return; +// this.client.sendMessage(id, input2); +// }) +// }) +// } + +// } \ No newline at end of file diff --git a/dev/zotero/context-registry.ts b/dev/zotero/context-registry.ts new file mode 100644 index 0000000..da96485 --- /dev/null +++ b/dev/zotero/context-registry.ts @@ -0,0 +1,22 @@ +import DocumentContext from "./models/document-context"; +import DocumentField from "./models/document-field"; + +export default class DocumentContextRegistry { + private static readonly idContextMap = new Map(); + + static isEmpty(): boolean { + return this.idContextMap.size == 0; + } + + static register(id:number, context: DocumentContext) { + this.idContextMap.set(id, context); + } + + static getDocumentById(id: number): DocumentContext { + return this.idContextMap.get(id); + } + + static getFieldByDocumentId(id: number): DocumentField { + return this.getDocumentById(id).getField(); + } +} \ No newline at end of file diff --git a/dev/zotero/handlers/get-active-doc-handler.ts b/dev/zotero/handlers/get-active-doc-handler.ts new file mode 100644 index 0000000..6634435 --- /dev/null +++ b/dev/zotero/handlers/get-active-doc-handler.ts @@ -0,0 +1,18 @@ +import DocumentContext from "../models/document-context"; +import DocumentContextRegistry from "../context-registry"; +import ZoteroServerCommandHandler from "../zotero-server-command-handler"; + +export default class GetActiveDocumentHandler implements ZoteroServerCommandHandler { + shouldHandle(command: string): boolean { + return command == 'Application_getActiveDocument'; + } + + handle(args: [protocolVersion: number]): string { + let protocolVersion = args[0]; + let id = 1 + if (DocumentContextRegistry.isEmpty()) { + DocumentContextRegistry.register(id, new DocumentContext(id)); + } + return `[${protocolVersion},${id}]`; + } +} \ No newline at end of file diff --git a/dev/zotero/handlers/get-document-data-handler.ts b/dev/zotero/handlers/get-document-data-handler.ts new file mode 100644 index 0000000..98fb898 --- /dev/null +++ b/dev/zotero/handlers/get-document-data-handler.ts @@ -0,0 +1,13 @@ +import DocumentContextRegistry from "../context-registry"; +import ZoteroServerCommandHandler from "../zotero-server-command-handler"; + +export default class GetDocumentDataHandler implements ZoteroServerCommandHandler { + shouldHandle(command: string): boolean { + return command == 'Document_getDocumentData'; + } + + handle(args: [id: number]): string { + let context = DocumentContextRegistry.getDocumentById(args[0]); + return `"${context.getDocumentData()}"`; + } +} \ No newline at end of file diff --git a/dev/zotero/io.ts b/dev/zotero/io.ts new file mode 100644 index 0000000..3862846 --- /dev/null +++ b/dev/zotero/io.ts @@ -0,0 +1,41 @@ +// Função para converter texto JSON para um buffer binário +export function createRpcPayload(transctionId: number, command: string): Buffer { + // O comando JSON que você deseja enviar + const payload = command; + + // Trans ID: Aqui estamos utilizando uma string de 8 bytes para simular um ID de transação. Você pode ajustá-lo conforme necessário. + const transId = Buffer.alloc(4); // 8 bytes de TRANS ID, por exemplo, preenchido com 0 + transId.writeUInt32BE(transctionId, 0); + + // Calculando o comprimento do payload + const payloadBuffer = Buffer.from(payload); + const length = Buffer.alloc(4); // Comprimento do payload em 2 bytes (hexadecimal) + length.writeUInt32BE(command.length, 0); // Escreve o comprimento no buffer em Big Endian + + + // Montando o pacote completo: [TRANS ID] [LENGTH] [PAYLOAD] + const message = Buffer.concat([transId, length, payloadBuffer]); + + return message; +} + +export function deserializeRpcMessage(buffer: Buffer) { + // Extrair o TRANS ID (8 bytes) + const transId = buffer.slice(0, 4); // Os primeiros 8 bytes são o Trans ID + + // Extrair o comprimento do payload (2 bytes) + const length = buffer.readUInt32BE(4); // Lê os próximos 2 bytes a partir da posição 8 + + // Extrair o PAYLOAD (o conteúdo JSON) baseado no comprimento + const payloadBuffer = buffer.slice(8, 8 + length); // A partir do byte 10 até o comprimento calculado + const payload = payloadBuffer.toString('utf8'); // Convertendo o buffer para string UTF-8 + + // Parse o payload JSON + try { + const parsedPayload = JSON.parse(payload); + return parsedPayload; // Retornando o transId e o payload parseado + } catch (error) { + console.error('Erro ao parsear o Payload JSON:', error); + return { transId, parsedPayload: null }; + } +} \ No newline at end of file diff --git a/dev/zotero/models/document-context.ts b/dev/zotero/models/document-context.ts new file mode 100644 index 0000000..ae982e3 --- /dev/null +++ b/dev/zotero/models/document-context.ts @@ -0,0 +1,29 @@ +import DocumentField from "./document-field"; + +export default class DocumentContext { + private id: number; + private documentData: string = ''; + private field: DocumentField; + + constructor(id: number) { + this.id = id; + } + + setDocumentData(value: string): void { + this.documentData = value; + } + + getDocumentData(): string { + // return `'; + +export { MLA }; diff --git a/test/suite/index.ts b/test/suite/index.ts new file mode 100644 index 0000000..0728362 --- /dev/null +++ b/test/suite/index.ts @@ -0,0 +1,44 @@ +import * as path from 'path'; +import Mocha from 'mocha'; +import glob from 'glob'; +import * as vscode from 'vscode'; + +export async function run(): Promise { + const extension = vscode.extensions.getExtension('igorjrd.cslpreview'); + if (!extension) { + throw new Error('Extension not found'); + } + await extension.activate(); + + vscode.commands.executeCommand('workbench.action.closeAllEditors'); + + // Create the mocha test + const mocha = new Mocha({ + ui: 'tdd' + }); + + const testsRoot = path.resolve(__dirname, '..'); + + return new Promise((c, e) => { + glob('**/**.test.js', { cwd: testsRoot }, (err, files) => { + if (err) { + return e(err); + } + + files.forEach(f => mocha.addFile(path.resolve(testsRoot, f))); + + try { + mocha.run(failures => { + if (failures > 0) { + e(new Error(`${failures} tests failed.`)); + } else { + c(); + } + }); + } catch (err) { + console.error(err); + e(err); + } + }); + }); +} \ No newline at end of file diff --git a/test/suite/validator.test.ts b/test/suite/validator.test.ts new file mode 100644 index 0000000..e1cbfc7 --- /dev/null +++ b/test/suite/validator.test.ts @@ -0,0 +1,14 @@ +import * as assert from 'assert'; +import validate from '../../libs/csl-validator'; +import { MLA } from './fixtures'; + + +suite('csl-validator.js integration tests', () => { + test('Valid test', () => { + assert.strictEqual(validate(MLA), ''); + }); + + test('Invalid test', () => { + assert.notStrictEqual(validate(MLA.replace(' Date: Wed, 22 Apr 2026 22:52:29 -0300 Subject: [PATCH 3/6] chore: ci pipeline --- .github/workflows/ci.yaml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/ci.yaml diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..7f79566 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,30 @@ +on: + push: + branches: + - master + - development + pull_request: + workflow_dispatch: + +jobs: + test: + name: Test + strategy: + matrix: + os: [macos-latest, ubuntu-latest, windows-latest] + runs-on: ${{ matrix.os }} + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + submodules: recursive + - name: Setup Node.js + uses: actions/setup-node@v1 + with: + node-version: '25.8.2' + - name: Install dependencies + run: npm install + - name: Run headless test + uses: GabrielBB/xvfb-action@v1.0 + with: + run: npm test From ac3677db0d00a076fc71dede73253b4a0ed58dc4 Mon Sep 17 00:00:00 2001 From: igorjrd Date: Wed, 22 Apr 2026 23:14:03 -0300 Subject: [PATCH 4/6] fix: fixes locale submodule --- resources/locales | 1 + 1 file changed, 1 insertion(+) create mode 160000 resources/locales diff --git a/resources/locales b/resources/locales new file mode 160000 index 0000000..938c09c --- /dev/null +++ b/resources/locales @@ -0,0 +1 @@ +Subproject commit 938c09c164a60b3cfeabe61089f1bf4c3ea6a4ed From f4d7eaec78b3b4d3ddbff4f178a73c868c293cb5 Mon Sep 17 00:00:00 2001 From: igorjrd Date: Wed, 22 Apr 2026 23:22:11 -0300 Subject: [PATCH 5/6] chore: bump actions versions --- .github/workflows/ci.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 7f79566..ea011a7 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -15,16 +15,16 @@ jobs: runs-on: ${{ matrix.os }} steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v6.0.2 with: submodules: recursive - name: Setup Node.js - uses: actions/setup-node@v1 + uses: actions/setup-node@v6.4.0 with: node-version: '25.8.2' - name: Install dependencies run: npm install - name: Run headless test - uses: GabrielBB/xvfb-action@v1.0 + uses: GabrielBB/xvfb-action@v1.7 with: run: npm test From c7b20f57600c0948588bd034575b40b307e0ef48 Mon Sep 17 00:00:00 2001 From: igorjrd Date: Thu, 23 Apr 2026 21:36:50 -0300 Subject: [PATCH 6/6] chore: release pipeline --- .github/workflows/release.yaml | 141 +++++++++++++++++++++++++++++++++ 1 file changed, 141 insertions(+) create mode 100644 .github/workflows/release.yaml diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..26a39ea --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,141 @@ +on: + workflow_dispatch: + inputs: + bump: + description: 'Tipo de bump de versão' + required: true + type: choice + options: + - patch + - minor + - major + suffix: + description: 'Sufixo de pré-lançamento: alpha, beta ou rc (opcionalmente com índice, ex.: rc-1)' + required: false + type: string + default: '' + +jobs: + release: + name: Publish and release + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Generate GitHub App token + id: generate-token + uses: actions/create-github-app-token@v2 + with: + app-id: ${{ vars.CI_APP_ID }} + private-key: ${{ secrets.CI_APP_PRIVATE_KEY }} + - name: Checkout + uses: actions/checkout@v6.0.2 + with: + token: ${{ steps.generate-token.outputs.token }} + fetch-depth: 0 + - name: Validate release channel and branch + run: | + BRANCH="${GITHUB_REF_NAME}" + SUFFIX="${{ inputs.suffix }}" + + if [ -z "$SUFFIX" ]; then + if [ "$BRANCH" != "main" ]; then + echo "Release estável (sem sufixo) só pode ser executado na branch main." + exit 1 + fi + exit 0 + fi + + if [[ ! "$SUFFIX" =~ ^(alpha|beta|rc)(-[0-9]+)?$ ]]; then + echo "Sufixo inválido: '$SUFFIX'. Valores permitidos: alpha, beta, rc (com índice opcional, ex.: rc-1) ou vazio." + exit 1 + fi + + CHANNEL="${SUFFIX%%-*}" + + if [ "$CHANNEL" = "beta" ] || [ "$CHANNEL" = "rc" ]; then + if [ "$BRANCH" != "development" ]; then + echo "Pré-release ($SUFFIX) só pode ser executado na branch development." + exit 1 + fi + exit 0 + fi + + if [ "$CHANNEL" = "alpha" ]; then + if [ "$BRANCH" = "main" ] || [ "$BRANCH" = "development" ]; then + echo "Pré-release ($SUFFIX) não pode ser executado nas branches main ou development." + exit 1 + fi + exit 0 + fi + - name: Calculate new version + id: release_tag + run: | + CURRENT=$(jq -r '.version' package.json | sed 's/-.*//') + IFS='.' read -r MAJOR MINOR PATCH <<< "$CURRENT" + + case "${{ inputs.bump }}" in + major) MAJOR=$((MAJOR + 1)); MINOR=0; PATCH=0 ;; + minor) MINOR=$((MINOR + 1)); PATCH=0 ;; + patch) PATCH=$((PATCH + 1)) ;; + esac + + VERSION="$MAJOR.$MINOR.$PATCH" + SUFFIX="${{ inputs.suffix }}" + if [ -n "$SUFFIX" ]; then + VERSION="$VERSION-$SUFFIX" + fi + + TAG="$VERSION" + + git fetch --tags --force + if git ls-remote --exit-code --tags origin "refs/tags/$TAG" > /dev/null 2>&1; then + echo "Tag já existe no remoto: $TAG" + exit 1 + fi + + echo "tag=$TAG" >> "$GITHUB_OUTPUT" + echo "version=$VERSION" >> "$GITHUB_OUTPUT" + - name: Setup Node.js + uses: actions/setup-node@v6.4.0 + with: + node-version: '20' + - name: Install dependencies + run: npm ci + - name: Set package version from input tag + run: npm version ${{ steps.release_tag.outputs.version }} --no-git-tag-version + - name: Resolve publish arguments + id: publish_args + run: | + ARGS="publish -p $VSCE_TOKEN" + + if [ -n "${{ inputs.suffix }}" ]; then + ARGS="$ARGS --pre-release" + fi + + echo "args=$ARGS" >> "$GITHUB_OUTPUT" + # - name: Publish extension + # uses: JCofman/vscodeaction@v3.0.0 + # env: + # VSCE_TOKEN: ${{ secrets.VSCE_TOKEN }} + # with: + # args: ${{ steps.publish_args.outputs.args }} + - name: Configure Git user + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + - name: Commit release version + run: | + git add package.json package-lock.json 2>/dev/null || git add package.json + git commit -m "chore(release): ${{ steps.release_tag.outputs.tag }} [skip ci]" + - name: Create and push tag + run: | + git tag "${{ steps.release_tag.outputs.tag }}" + git push origin HEAD + git push origin "${{ steps.release_tag.outputs.tag }}" + - name: Create GitHub release + uses: softprops/action-gh-release@v2 + with: + tag_name: ${{ steps.release_tag.outputs.tag }} + generate_release_notes: true + prerelease: ${{ inputs.suffix != '' }}