Codext

View and edit code from within your browser!

_{On the left: Firefox and Chrome without Codext. On the right: same webpages with Codext enabled!}

Installation

This plugin is available for installation on the Chrome Web Store and the Firefox Add-ons Store.

Features at a glance

Codext harnesses the power of the Monaco Editor by dynamically inserting it into webpages. The extension targets preformatted text (i.e. pages containing a unique <pre> tag) and determines the programming language to use by looking at the URL's extension and/or the returned Content-Type header. An editor instance is fully configured on the fly and in addition to standard features such as syntax highlighting, section folding and code formatting, Codext allows users to interact with documents and export changes locally.

Codext will help you out with the following tasks:

displaying code from online file systems or repositories.
opening and viewing local files in your browser.
prettifying API responses (e.g. GET requests returning YAML).
making quick changes to files and downloading those changes locally.
viewing GitLab/Bitbucket raw files in a proper editor.
and any use-case you can think of!

Right-click anywhere in a loaded editor to display additional options such as code formatting. To temporarily turn Codext off, right-click on its icon in the browser's toolbar, select Disable extension and refresh the page!

Getting started as a developer

Make sure you're using a recent version of Node.js (latest build successfully performed with release 16.13.1).

npm is used to handle dependencies. Install them by running npm i in the root directory of the project.

gulp is required for the steps listed below. Use npm install gulp-cli -g to install the gulp command line tool.

💿 Building the project

Simply run gulp build. The command will generate the following in the build folder:

a minified version of all the files required to run the extension. To load the extension in developer mode, point the browser to manifest.json in the build folder.
a zip archive that can be used to publish the extension to the Chrome Web Store or to the Firefox Add-Ons Store.

🔨 Running the tests

The jasmine and sinon-chrome libraries are used for the tests. All tested files are injected in a Jasmine spec runner document, which can be opened in a web browser to assert that the code is behaving as intended.

to launch the test suite in Chrome, run gulp test.
to launch the test suite in Firefox, run gulp test-firefox.

📈 Running the reporter

ESLint can be run with the gulp lint command.

✏️ Formatting the code

Prettier can be run with the gulp prettify command.

Contributing

`$ code`

Codext was built by Pierre-Yves and Mika during a BBC hackaton. Want to make the project better, faster, stronger? Contributions are more than welcome, open a pull request and share your code! Simply fork the repository by clicking on the icon on the top right of this page and you're ready to go!

💬 Support

Thought of a cool idea? Found a problem or need some help? Simply open an issue!

⭐ Thanks

Find the project useful, fun or interesting? Star the repository by clicking on the icon on the top right of this page!

Known issues

Codext may not load in pages that have a CSP sandbox policy (for instance GitHub raw pages). In Chrome and Opera, this is due to a regression introduced in Chromium 64 (see 816121). In Firefox, a similar bug affects most recent versions of the browser (see 1267027).

Acknowledgements

The following open-source projects are used to power Codext:

monaco-editor, released by Microsoft under the MIT License.
requirejs, released under the MIT License.

License and copyright

Apache License 2.0, see LICENSE for more details.

oevl / codext Goto Github PK

codext's Introduction