Skip to content

Commit a6e1d65

Browse files
committed
fix readme for formatting
1 parent d5042a7 commit a6e1d65

File tree

3 files changed

+127
-122
lines changed

3 files changed

+127
-122
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3+
## [0.3.1] - 09-07-2019 (DD-MM-YYYY)
4+
### Patch
5+
- fix formatting issues in README.md
6+
7+
## [0.3.0] - 09-07-2019 (DD-MM-YYYY)
8+
### Update
9+
- add Protocol Element Commands and fix other commands
10+
311
## [0.2.2] - 13-11-2018 (DD-MM-YYYY)
412
### Patch
513
- fix the initial position of cursor

README.md

Lines changed: 118 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -15,169 +15,166 @@
1515

1616
## Assert/Verify
1717

18-
:heavy_check_mark: **attributeContains**(selector, attribute, expected, optionalMessage)\
19-
:heavy_check_mark: **attributeEquals**(selector, attribute, expected, optionalMessage)\
20-
:heavy_check_mark: **containsText**(selector, expectedText, optionalMessage)\
21-
:heavy_check_mark: **cssClassPresent**(selector, className, optionalMessage)\
22-
:heavy_check_mark: **cssClassNotPresent**(selector, className, optionalMessage)\
23-
:heavy_check_mark: **cssProperty**(selector, cssProperty, expected, optionalMessage)\
24-
:heavy_check_mark: **elementPresent**(selector, optionalMessage)\
25-
:heavy_check_mark: **elementNotPresent**(selector, optionalMessage)\
26-
:heavy_check_mark: **hidden**(selector, optionalMessage)\
27-
:heavy_check_mark: **title**(expected, optionalMessage)\
28-
:heavy_check_mark: **titleContains**(expected, optionalMessage)\
29-
:heavy_check_mark: **urlContains**(expectedText, optionalMessage)\
30-
:heavy_check_mark: **urlEquals**(expected, optionalMessage)\
31-
:heavy_check_mark: **value**(expectedText, optionalMessage)\
32-
:heavy_check_mark: **valueContains**(selector, expectedText, optionalMessage)\
33-
:heavy_check_mark: **visible**(selector, optionalMessage)
18+
* **attributeContains**(selector, attribute, expected, optionalMessage)\
19+
* **attributeEquals**(selector, attribute, expected, optionalMessage)\
20+
* **containsText**(selector, expectedText, optionalMessage)\
21+
* **cssClassPresent**(selector, className, optionalMessage)\
22+
* **cssClassNotPresent**(selector, className, optionalMessage)\
23+
* **cssProperty**(selector, cssProperty, expected, optionalMessage)\
24+
* **elementPresent**(selector, optionalMessage)\
25+
* **elementNotPresent**(selector, optionalMessage)\
26+
* **hidden**(selector, optionalMessage)\
27+
* **title**(expected, optionalMessage)\
28+
* **titleContains**(expected, optionalMessage)\
29+
* **urlContains**(expectedText, optionalMessage)\
30+
* **urlEquals**(expected, optionalMessage)\
31+
* **value**(expectedText, optionalMessage)\
32+
* **valueContains**(selector, expectedText, optionalMessage)\
33+
* **visible**(selector, optionalMessage)
3434

3535
## Finding Elements
3636

37-
:heavy_check_mark: **waitForElementNotVisible**(optionalUsing, selector, optionalWaitForConditionTimeout, optionalWaitForConditionPollInterval, optionalAbortOnAssertionFailure, optionalCallback, optionalMessage)\
38-
:heavy_check_mark: **waitForElementNotPresent**(optionalUsing, selector, optionalWaitForConditionTimeout, optionalWaitForConditionPollInterval, optionalAbortOnAssertionFailure, optionalCallback, optionalMessage)\
39-
:heavy_check_mark: **waitForElementPresent**(optionalUsing, selector, optionalWaitForConditionTimeout, optionalWaitForConditionPollInterval, optionalAbortOnAssertionFailure, optionalCallback, optionalMessage)\
40-
:heavy_check_mark: **waitForElementVisible**(optionalUsing, selector, optionalWaitForConditionTimeout, optionalWaitForConditionPollInterval, optionalAbortOnAssertionFailure, optionalCallback, optionalMessage)\
41-
:heavy_check_mark: **element**(using, value, callback)\
42-
:heavy_check_mark: **elements**(using, value, callback)\
43-
:heavy_check_mark: **elementIdEquals**(webElementId, otherId, callback)\
44-
:heavy_check_mark: **elementIdElement**(webElementId, using, value, callback)\
45-
:heavy_check_mark: **elementIdElements**(webElementId, using, value, callback)
37+
* **waitForElementNotVisible**(optionalUsing, selector, optionalWaitForConditionTimeout, optionalWaitForConditionPollInterval, optionalAbortOnAssertionFailure, optionalCallback, optionalMessage)\
38+
* **waitForElementNotPresent**(optionalUsing, selector, optionalWaitForConditionTimeout, optionalWaitForConditionPollInterval, optionalAbortOnAssertionFailure, optionalCallback, optionalMessage)\
39+
* **waitForElementPresent**(optionalUsing, selector, optionalWaitForConditionTimeout, optionalWaitForConditionPollInterval, optionalAbortOnAssertionFailure, optionalCallback, optionalMessage)\
40+
* **waitForElementVisible**(optionalUsing, selector, optionalWaitForConditionTimeout, optionalWaitForConditionPollInterval, optionalAbortOnAssertionFailure, optionalCallback, optionalMessage)\
41+
* **element**(using, value, callback)\
42+
* **elements**(using, value, callback)\
43+
* **elementIdEquals**(webElementId, otherId, callback)\
44+
* **elementIdElement**(webElementId, using, value, callback)\
45+
* **elementIdElements**(webElementId, using, value, callback)
4646

4747
## Element Interaction
4848

49-
:heavy_check_mark: **click**(optionalUsing, selector, optionalCallback)\
50-
:heavy_check_mark: **clearValue**(selector, optionalCallback)\
51-
:heavy_check_mark: **moveToElement**(selector, xoffset, yoffset, optionalCallback)\
52-
:heavy_check_mark: **setValue**(selector, inputValue, optionalCallback)\
53-
:heavy_check_mark: **submitForm**(selector, optionalCallback)\
54-
:heavy_check_mark: **keys**(keysToSend, optionalCallback)
49+
* **click**(optionalUsing, selector, optionalCallback)\
50+
* **clearValue**(selector, optionalCallback)\
51+
* **moveToElement**(selector, xoffset, yoffset, optionalCallback)\
52+
* **setValue**(selector, inputValue, optionalCallback)\
53+
* **submitForm**(selector, optionalCallback)\
54+
* **keys**(keysToSend, optionalCallback)
5555

5656
## Element State
5757

58-
:heavy_check_mark: **getAttribute**(selector, attribute, callback)\
59-
:heavy_check_mark: **getCssProperty**(selector, cssProperty, callback)\
60-
:heavy_check_mark: **getElementSize**(selector, callback)\
61-
:heavy_check_mark: **getTagName**(selector, callback)\
62-
:heavy_check_mark: **getText**(optionalUsing, selector, callback)\
63-
:heavy_check_mark: **getValue**(selector, callback)\
64-
:heavy_check_mark: **isVisible**(selector, callback)\
65-
:heavy_check_mark: **elementActive**(callback)
58+
* **getAttribute**(selector, attribute, callback)\
59+
* **getCssProperty**(selector, cssProperty, callback)\
60+
* **getElementSize**(selector, callback)\
61+
* **getTagName**(selector, callback)\
62+
* **getText**(optionalUsing, selector, callback)\
63+
* **getValue**(selector, callback)\
64+
* **isVisible**(selector, callback)\
65+
* **elementActive**(callback)
6666

6767
## Element Location
6868

69-
:heavy_check_mark: **getLocation**(selector, callback)\
70-
:heavy_check_mark: **getLocationInView**(selector, callback)
69+
* **getLocation**(selector, callback)\
70+
* **getLocationInView**(selector, callback)
7171

7272
## Protocol Element Commands
7373

74-
:heavy_check_mark: **elementIdAttribute**(webElementId, attributeName, callback)\
75-
:heavy_check_mark: **elementIdCssProperty**(webElementId, cssPropertyName, callback)\
76-
:heavy_check_mark: **elementIdClear**(webElementId, optionalCallback)\
77-
:heavy_check_mark: **elementIdClick**(webElementId, optionalCallback)\
78-
:heavy_check_mark: **elementIdDisplayed**(webElementId, callback)\
79-
:heavy_check_mark: **elementIdEnabled**(webElementId, callback)\
80-
:heavy_check_mark: **elementIdLocationInView**(webElementId, optionalCallback)\
81-
:heavy_check_mark: **elementIdLocation**(webElementId, callback)\
82-
:heavy_check_mark: **elementIdName**(webElementId, callback)\
83-
:heavy_check_mark: **elementIdSelected**(webElementId, callback)\
84-
:heavy_check_mark: **elementIdSize**(webElementId, callback)\
85-
:heavy_check_mark: **elementIdText**(webElementId, callback)\
86-
:heavy_check_mark: **elementIdValue**(webElementId, optionalValue, callback)\
87-
:heavy_check_mark: **submit**(webElementId, optionalCallback)
74+
* **elementIdAttribute**(webElementId, attributeName, callback)\
75+
* **elementIdCssProperty**(webElementId, cssPropertyName, callback)\
76+
* **elementIdClear**(webElementId, optionalCallback)\
77+
* **elementIdClick**(webElementId, optionalCallback)\
78+
* **elementIdDisplayed**(webElementId, callback)\
79+
* **elementIdEnabled**(webElementId, callback)\
80+
* **elementIdLocationInView**(webElementId, optionalCallback)\
81+
* **elementIdLocation**(webElementId, callback)\
82+
* **elementIdName**(webElementId, callback)\
83+
* **elementIdSelected**(webElementId, callback)\
84+
* **elementIdSize**(webElementId, callback)\
85+
* **elementIdText**(webElementId, callback)\
86+
* **elementIdValue**(webElementId, optionalValue, callback)\
87+
* **submit**(webElementId, optionalCallback)
8888

8989
## Document Handling
9090

91-
:heavy_check_mark: **injectScript**(scriptUrl, optionalId, optionalCallback)\
92-
:x: **execute**(body, args, optionalCallback)\
93-
:x: **executeAsync**(script, args, optionalCallback)\
94-
:x: **source**(callback)
91+
* **injectScript**(scriptUrl, optionalId, optionalCallback)\
92+
* **execute**(body, args, optionalCallback) - future release\
93+
* **executeAsync**(script, args, optionalCallback) - future release\
94+
* **source**(callback) - future release
9595

9696
## Sessions
9797

98-
:heavy_check_mark: **end**(optionalCallback)\
99-
:heavy_check_mark: **getLogTypes**(callback)\
100-
:heavy_check_mark: **getLog**(typeString, callback)\
101-
:heavy_check_mark: **isLogAvailable**(typeString, callback)\
102-
:x: **session**(optionalAction, optionalSessionId, optionalCallback)\
103-
:x: **sessions**(callback)\
104-
:x: **timeouts**(type, ms, optionalCallback)\
105-
:x: **timeoutsAsyncScript**(ms, optionalCallback)\
106-
:x: **timeoutsImplicitWait**(ms, optionalCallback)\
107-
:x: **status**(callback)\
108-
:x: **sessionLog**(typeString, callback)\
109-
:x: **sessionLogTypes**(callback)
98+
* **end**(optionalCallback)\
99+
* **getLogTypes**(callback)\
100+
* **getLog**(typeString, callback)\
101+
* **isLogAvailable**(typeString, callback)\
102+
* **session**(optionalAction, optionalSessionId, optionalCallback) - future release\
103+
* **sessions**(callback) - future release\
104+
* **timeouts**(type, ms, optionalCallback) - future release\
105+
* **timeoutsAsyncScript**(ms, optionalCallback) - future release\
106+
* **timeoutsImplicitWait**(ms, optionalCallback) - future release\
107+
* **status**(callback) - future release\
108+
* **sessionLog**(typeString, callback) - future release\
109+
* **sessionLogTypes**(callback) - future release
110110

111111
## Navigation
112112

113-
:heavy_check_mark: **init**(optionalURL, optionalCallback)\
114-
:heavy_check_mark: **getTitle**(callback)\
115-
:heavy_check_mark: **urlHash**(hash, optionalCallback)\
116-
:x: **url**(optionalURL, optionalCallback)\
117-
:x: **back**(optionalCallback)\
118-
:x: **forward**(optionalCallback)\
119-
:x: **refresh**(optionalCallback)\
120-
:x: **title**(callback)
113+
* **init**(optionalURL, optionalCallback)\
114+
* **getTitle**(callback)\
115+
* **urlHash**(hash, optionalCallback)\
116+
* **url**(optionalURL, optionalCallback) - future release\
117+
* **back**(optionalCallback) - future release\
118+
* **forward**(optionalCallback) - future release\
119+
* **refresh**(optionalCallback) - future release\
120+
* **title**(callback) - future release
121121

122122
## Window Related
123123

124-
:heavy_check_mark: **closeWindow**(optionalCallback)\
125-
:heavy_check_mark: **resizeWindow**(width, height, optionalCallback)\
126-
:heavy_check_mark: **maximizeWindow**(optionalCallback)\
127-
:heavy_check_mark: **switchWindow**(handleOrName, optionalCallback)\
128-
:heavy_check_mark: **setWindowPosition**(offsetX, offsetY, optionalCallback)\
129-
:x: **window**(method, handleOrName, optionalCallback)\
130-
:x: **windowHandle**(callback)\
131-
:x: **windowHandles**(callback)\
132-
:x: **windowMaximize**(optionalHandleOrName, optionalCallback)\
133-
:x: **windowPosition**(windowHandle, offsetX, offsetY, callback)\
134-
:x: **windowSize**(windowHandle, width, height, optionalCallback)\
135-
:x: **frame**(optionalFrameID, optionalCallback)\
136-
:x: **frameParent**(optionalCallback)
124+
* **closeWindow**(optionalCallback)\
125+
* **resizeWindow**(width, height, optionalCallback)\
126+
* **maximizeWindow**(optionalCallback)\
127+
* **switchWindow**(handleOrName, optionalCallback)\
128+
* **setWindowPosition**(offsetX, offsetY, optionalCallback)\
129+
* **window**(method, handleOrName, optionalCallback) - future release\
130+
* **windowHandle**(callback) - future release\
131+
* **windowHandles**(callback) - future release\
132+
* **windowMaximize**(optionalHandleOrName, optionalCallback) - future release\
133+
* **windowPosition**(windowHandle, offsetX, offsetY, callback) - future release\
134+
* **windowSize**(windowHandle, width, height, optionalCallback) - future release\
135+
* **frame**(optionalFrameID, optionalCallback) - future release\
136+
* **frameParent**(optionalCallback) - future release
137137

138138
## Cookies
139139

140-
:heavy_check_mark: **getCookies**(callback)\
141-
:heavy_check_mark: **getCookie**(cookieName, callback)\
142-
:heavy_check_mark: **setCookie**(cookie object, optionalCallback)\
143-
:heavy_check_mark: **deleteCookie**(cookieName, optionalCallback)\
144-
:heavy_check_mark: **deleteCookies**(optionalCallback)\
145-
:x: **cookie**(method, optionalCallbackOrCookie)
140+
* **getCookies**(callback)\
141+
* **getCookie**(cookieName, callback)\
142+
* **setCookie**(cookie object, optionalCallback)\
143+
* **deleteCookie**(cookieName, optionalCallback)\
144+
* **deleteCookies**(optionalCallback)\
145+
* **cookie**(method, optionalCallbackOrCookie) - future release
146146

147147
## User Actions
148148

149-
:x: **doubleClick**(optionalCallback)\
150-
:x: **mouseButtonClick**(button, optionalCallback)\
151-
:x: **mouseButtonDown**(button, optionalCallback)\
152-
:x: **mouseButtonUp**(button, optionalCallback)\
153-
:x: **moveTo**(optionalWebElementId, xoffset, yoffset, optionalCallback)
149+
* **doubleClick**(optionalCallback) - future release\
150+
* **mouseButtonClick**(button, optionalCallback) - future release\
151+
* **mouseButtonDown**(button, optionalCallback) - future release\
152+
* **mouseButtonUp**(button, optionalCallback) - future release\
153+
* **moveTo**(optionalWebElementId, xoffset, yoffset, optionalCallback) - future release
154154

155155
## User Prompts
156156

157-
:x: **acceptAlert**(optionalCallback)\
158-
:x: **dismissAlert**(optionalCallback)\
159-
:x: **getAlertText**(callback)\
160-
:x: **setAlertText**(value, optionalCallback)
157+
* **acceptAlert**(optionalCallback) - future release\
158+
* **dismissAlert**(optionalCallback) - future release\
159+
* **getAlertText**(callback) - future release\
160+
* **setAlertText**(value, optionalCallback) - future release
161161

162162
## Screen Capture
163163

164-
:x: **saveScreenshot**(fileName, optionalCallback)\
165-
:x: **screenshot**(log_screenshot_data, callback)
164+
* **saveScreenshot**(fileName, optionalCallback) - future release\
165+
* **screenshot**(log_screenshot_data, callback) - future release
166166

167167
## Mobile Related
168168

169-
:x: **getOrientation**(callback)\
170-
:x: **setOrientation**(orientation, optionalCallback)\
171-
:x: **contexts**(callback)\
172-
:x: **currentContext**(callback)\
173-
:x: **setContext**(context, optionalCallback)
169+
* **getOrientation**(callback) - future release\
170+
* **setOrientation**(orientation, optionalCallback) - future release\
171+
* **contexts**(callback) - future release\
172+
* **currentContext**(callback) - future release\
173+
* **setContext**(context, optionalCallback) - future release
174174

175175
## Utilities / Debugging
176176

177-
:heavy_check_mark: **pause**(ms, optionalCallback)\
178-
:heavy_check_mark: **useCss**(optionalCallback)\
179-
:heavy_check_mark: **useXpath**(optionalCallback)\
180-
:heavy_check_mark: **perform**(callback)
181-
182-
183-
<p align="center"><b>Built with :heart:</b></p>
177+
* **pause**(ms, optionalCallback)\
178+
* **useCss**(optionalCallback)\
179+
* **useXpath**(optionalCallback)\
180+
* **perform**(callback)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vscode-nightwatchjs-snippets",
3-
"version": "0.3.0",
3+
"version": "0.3.1",
44
"description": "NightwatchJS code snippets for Visual Studio Code",
55
"displayName": "NightwatchJS snippets",
66
"publisher": "Raju",

0 commit comments

Comments
 (0)